elasticsearch-xpack 7.4.0 → 7.5.0.pre.pre

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

@@ -7,39 +7,53 @@ module Elasticsearch
     module API
       module Graph
         module Actions
+          # TODO: Description
 
-          # Get structured information about the vertices and connections in a dataset
           #
-          # @option arguments [List] :index A comma-separated list of index names to search;
-          #                                 use `_all` or empty string to perform the operation on all indices
-          # @option arguments [List] :type A comma-separated list of document types to search;
-          #                                leave empty to perform the operation on all types
-          # @option arguments [Hash] :body The Graph Query DSL definition
+          # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
+          # @option arguments [List] :type A comma-separated list of document types to search; leave empty to perform the operation on all types   *Deprecated*
           # @option arguments [String] :routing Specific routing value
           # @option arguments [Time] :timeout Explicit operation timeout
+
+          # @option arguments [Hash] :body Graph Query DSL
+          #
+          # *Deprecation notice*:
+          # Specifying types in urls has been deprecated
+          # Deprecated since version 7.0.0
           #
-          # @see https://www.elastic.co/guide/en/graph/current/explore.html
           #
-          def explore(arguments={})
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/graph-explore-api.html
+          #
+          def explore(arguments = {})
+            raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+
             arguments = arguments.clone
-            index = arguments.delete(:index)
-            type  = arguments.delete(:type)
+
+            _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'
+            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]
 
+            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
+          # @since 6.2.0
+          ParamsRegistry.register(:explore, [
+            :routing,
+            :timeout
+          ].freeze)
       end
     end
+    end
   end
 end

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

@@ -8,7 +8,6 @@ module Elasticsearch
       module Graph
         module Actions
           module ParamsRegistry
-
             extend self
 
             # A Mapping of all the actions to their list of valid params.

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

@@ -0,0 +1,36 @@
+# 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
+          # TODO: Description
+
+          #
+          # @option arguments [String] :policy The name of the index lifecycle policy
+
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-delete-lifecycle.html
+          #
+          def delete_lifecycle(arguments = {})
+            raise ArgumentError, "Required argument 'policy' missing" unless arguments[:policy]
+
+            arguments = arguments.clone
+
+            _policy = arguments.delete(:policy)
+
+            method = Elasticsearch::API::HTTP_DELETE
+            path   = "_ilm/policy/#{Elasticsearch::API::Utils.__listify(_policy)}"
+            params = {}
+
+            body = nil
+            perform_request(method, path, params, body).body
+          end
+      end
+    end
+    end
+  end
+end

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

@@ -7,7 +7,6 @@ module Elasticsearch
     module API
       module IndexLifecycleManagement
         module Actions
-
           # Deletes a lifecycle policy
           #
           # @option arguments [String] :policy_id Identifier for the policy
@@ -16,8 +15,9 @@ module Elasticsearch
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-delete-lifecycle.html
           #
-          def delete_policy(arguments={})
+          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])
@@ -29,9 +29,8 @@ module Elasticsearch
 
           # Register this action with its valid params when the module is loaded.
           #
-          ParamsRegistry.register(:delete_policy, [ :master_timeout,
-                                                    :timeout ].freeze)
-
+          ParamsRegistry.register(:delete_policy, [:master_timeout,
+                                                   :timeout].freeze)
         end
       end
     end

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

@@ -7,7 +7,6 @@ module Elasticsearch
     module API
       module IndexLifecycleManagement
         module Actions
-
           # Shows an index’s current lifecycle status
           #
           # @option arguments [String] :index The target index (*Required*)
@@ -16,8 +15,9 @@ module Elasticsearch
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-explain-lifecycle.html
           #
-          def explain(arguments={})
+          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
@@ -30,9 +30,8 @@ module Elasticsearch
 
           # Register this action with its valid params when the module is loaded.
           #
-          ParamsRegistry.register(:explain, [ :master_timeout,
-                                              :timeout ].freeze)
-
+          ParamsRegistry.register(:explain, [:master_timeout,
+                                             :timeout].freeze)
         end
       end
     end

data/lib/elasticsearch/xpack/api/actions/{migration/upgrade.rb → index_lifecycle_management/explain_lifecycle.rb}

@@ -5,32 +5,42 @@
 module Elasticsearch
   module XPack
     module API
-      module Migration
+      module IndexLifecycleManagement
         module Actions
+          # TODO: Description
 
-          # Perform the upgrade of internal indices to make them compatible with the next major version
           #
-          # @option arguments [String] :index The name of the index (*Required*)
-          # @option arguments [Boolean] :wait_for_completion Should the request block until the upgrade operation is completed
+          # @option arguments [String] :index The name of the index to explain
+          # @option arguments [Boolean] :only_managed filters the indices included in the response to ones managed by ILM
+          # @option arguments [Boolean] :only_errors filters the indices included in the response to ones in an ILM error state, implies only_managed
+
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-upgrade.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-explain-lifecycle.html
           #
-          def upgrade(arguments={})
+          def explain_lifecycle(arguments = {})
             raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
-            method = Elasticsearch::API::HTTP_POST
-            path   = Elasticsearch::API::Utils.__pathify "_xpack/migration/upgrade", arguments[:index]
+
+            arguments = arguments.clone
+
+            _index = arguments.delete(:index)
+
+            method = Elasticsearch::API::HTTP_GET
+            path   = "#{Elasticsearch::API::Utils.__listify(_index)}/_ilm/explain"
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-            body   = nil
 
+            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(:upgrade, [ :wait_for_completion ].freeze)
-        end
+          # @since 6.2.0
+          ParamsRegistry.register(:explain_lifecycle, [
+            :only_managed,
+            :only_errors
+          ].freeze)
       end
     end
+    end
   end
 end

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

@@ -0,0 +1,38 @@
+# 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
+          # TODO: Description
+
+          #
+          # @option arguments [String] :policy The name of the index lifecycle policy
+
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-lifecycle.html
+          #
+          def get_lifecycle(arguments = {})
+            arguments = arguments.clone
+
+            _policy = arguments.delete(:policy)
+
+            method = Elasticsearch::API::HTTP_GET
+            path   = if _policy
+                       "_ilm/policy/#{Elasticsearch::API::Utils.__listify(_policy)}"
+                     else
+                       "_ilm/policy"
+  end
+            params = {}
+
+            body = nil
+            perform_request(method, path, params, body).body
+          end
+      end
+    end
+    end
+  end
+end

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

@@ -7,7 +7,6 @@ module Elasticsearch
     module API
       module IndexLifecycleManagement
         module Actions
-
           # Retrieves a lifecycle policy
           #
           # @option arguments [String] :policy_id Identifier for the policy
@@ -16,7 +15,7 @@ module Elasticsearch
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-lifecycle.html
           #
-          def get_policy(arguments={})
+          def get_policy(arguments = {})
             method = Elasticsearch::API::HTTP_GET
             path   = Elasticsearch::API::Utils.__pathify "_ilm/policy",
                                                          Elasticsearch::API::Utils.__escape(arguments[:policy_id])
@@ -28,9 +27,8 @@ module Elasticsearch
 
           # Register this action with its valid params when the module is loaded.
           #
-          ParamsRegistry.register(:get_policy, [ :master_timeout,
-                                                 :timeout ].freeze)
-
+          ParamsRegistry.register(:get_policy, [:master_timeout,
+                                                :timeout].freeze)
         end
       end
     end

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

@@ -7,30 +7,23 @@ module Elasticsearch
     module API
       module IndexLifecycleManagement
         module Actions
+          # TODO: Description
 
-          # Retrieves the current index lifecycle management (ILM) status
-          #
-          # @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-get-status.html
           #
-          def get_status(arguments={})
+          def get_status(arguments = {})
+            arguments = arguments.clone
+
             method = Elasticsearch::API::HTTP_GET
             path   = "_ilm/status"
-            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-            body   = nil
+            params = {}
 
+            body = nil
             perform_request(method, path, params, body).body
           end
-
-          # Register this action with its valid params when the module is loaded.
-          #
-          ParamsRegistry.register(:get_status, [ :master_timeout,
-                                                 :timeout ].freeze)
-
-        end
       end
     end
+    end
   end
 end

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

@@ -7,35 +7,31 @@ module Elasticsearch
     module API
       module IndexLifecycleManagement
         module Actions
+          # TODO: Description
 
-          # Triggers execution of a specific step in the lifecycle policy
           #
-          # @option arguments [String] :index The target index (*Required*)
-          # @option arguments [Hash] :body The request template content (*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.
+          # @option arguments [String] :index The name of the index whose lifecycle step is to change
+
+          # @option arguments [Hash] :body The new lifecycle step to move to
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-move-to-step.html
           #
-          def move_to_step(arguments={})
+          def move_to_step(arguments = {})
             raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
-            raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+            arguments = arguments.clone
+
+            _index = arguments.delete(:index)
+
             method = Elasticsearch::API::HTTP_POST
-            index = Elasticsearch::API::Utils.__escape(arguments.delete(:index))
-            path   = Elasticsearch::API::Utils.__pathify "_ilm/move",
-                                                         index
-            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-            body   = arguments[:body]
+            path   = "_ilm/move/#{Elasticsearch::API::Utils.__listify(_index)}"
+            params = {}
 
+            body = arguments[:body]
             perform_request(method, path, params, body).body
           end
-
-          # Register this action with its valid params when the module is loaded.
-          #
-          ParamsRegistry.register(:move_to_step, [ :master_timeout,
-                                                   :timeout ].freeze)
-        end
       end
     end
+    end
   end
 end

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

@@ -8,7 +8,6 @@ module Elasticsearch
       module IndexLifecycleManagement
         module Actions
           module ParamsRegistry
-
             extend self
 
             # A Mapping of all the actions to their list of valid params.

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

@@ -0,0 +1,37 @@
+# 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
+          # TODO: Description
+
+          #
+          # @option arguments [String] :policy The name of the index lifecycle policy
+
+          # @option arguments [Hash] :body The lifecycle policy definition to register
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-put-lifecycle.html
+          #
+          def put_lifecycle(arguments = {})
+            raise ArgumentError, "Required argument 'policy' missing" unless arguments[:policy]
+
+            arguments = arguments.clone
+
+            _policy = arguments.delete(:policy)
+
+            method = Elasticsearch::API::HTTP_PUT
+            path   = "_ilm/policy/#{Elasticsearch::API::Utils.__listify(_policy)}"
+            params = {}
+
+            body = arguments[:body]
+            perform_request(method, path, params, body).body
+          end
+      end
+    end
+    end
+  end
+end

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

@@ -7,7 +7,6 @@ module Elasticsearch
     module API
       module IndexLifecycleManagement
         module Actions
-
           # Register a new watch in or update an existing one
           #
           # @option arguments [String] :policy_id Identifier for the policy (*Required*)
@@ -17,9 +16,10 @@ module Elasticsearch
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-put-lifecycle.html
           #
-          def put_policy(arguments={})
+          def put_policy(arguments = {})
             raise ArgumentError, "Required argument 'policy_id' missing" unless arguments[:policy_id]
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
             method = Elasticsearch::API::HTTP_PUT
             path   = Elasticsearch::API::Utils.__pathify "_ilm/policy",
                                                          Elasticsearch::API::Utils.__escape(arguments[:policy_id])
@@ -31,8 +31,8 @@ module Elasticsearch
 
           # Register this action with its valid params when the module is loaded.
           #
-          ParamsRegistry.register(:put_policy, [ :master_timeout,
-                                                 :timeout ].freeze)
+          ParamsRegistry.register(:put_policy, [:master_timeout,
+                                                :timeout].freeze)
         end
       end
     end