elasticsearch-api 6.1.0 → 6.2.0

data/lib/elasticsearch/api/actions/indices/clear_cache.rb

@@ -38,7 +38,21 @@ module Elasticsearch
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-clearcache.html
         #
         def clear_cache(arguments={})
-          valid_params = [
+          method = HTTP_POST
+          path   = Utils.__pathify Utils.__listify(arguments[:index]), '_cache/clear'
+
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          body   = nil
+
+          params[:fields] = Utils.__listify(params[:fields]) if params[:fields]
+
+          perform_request(method, path, params, body).body
+        end
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.2.0
+        ParamsRegistry.register(:clear_cache, [
             :field_data,
             :fielddata,
             :fields,
@@ -49,18 +63,7 @@ module Elasticsearch
             :index,
             :recycler,
             :request_cache,
-            :request ]
-
-          method = HTTP_POST
-          path   = Utils.__pathify Utils.__listify(arguments[:index]), '_cache/clear'
-
-          params = Utils.__validate_and_extract_params arguments, valid_params
-          body   = nil
-
-          params[:fields] = Utils.__listify(params[:fields]) if params[:fields]
-
-          perform_request(method, path, params, body).body
-        end
+            :request ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/indices/close.rb

@@ -28,23 +28,24 @@ module Elasticsearch
         #
         def close(arguments={})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
-
-          valid_params = [
-            :ignore_indices,
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards,
-            :timeout
-          ]
-
           method = HTTP_POST
           path   = Utils.__pathify Utils.__listify(arguments[:index]), '_close'
 
-          params = Utils.__validate_and_extract_params arguments, valid_params
+          params = 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 6.2.0
+        ParamsRegistry.register(:close, [
+            :ignore_indices,
+            :ignore_unavailable,
+            :allow_no_indices,
+            :expand_wildcards,
+            :timeout ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/indices/create.rb

@@ -70,21 +70,23 @@ module Elasticsearch
         #
         def create(arguments={})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
-          valid_params = [
-            :timeout,
-            :master_timeout,
-            :update_all_types,
-            :wait_for_active_shards
-          ]
-
           method = HTTP_PUT
           path   = Utils.__pathify Utils.__escape(arguments[:index])
 
-          params = Utils.__validate_and_extract_params arguments, valid_params
+          params = 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 6.2.0
+        ParamsRegistry.register(:create, [
+            :timeout,
+            :master_timeout,
+            :update_all_types,
+            :wait_for_active_shards ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/indices/delete.rb

@@ -34,18 +34,10 @@ module Elasticsearch
         # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-delete-index/
         #
         def delete(arguments={})
-          valid_params = [
-            :timeout,
-            :master_timeout,
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards
-           ]
-
           method = HTTP_DELETE
           path   = Utils.__pathify Utils.__listify(arguments[:index])
 
-          params = Utils.__validate_and_extract_params arguments, valid_params
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           body   = nil
 
           if Array(arguments[:ignore]).include?(404)
@@ -54,6 +46,16 @@ module Elasticsearch
             perform_request(method, path, params, body).body
           end
         end
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.2.0
+        ParamsRegistry.register(:delete, [
+            :timeout,
+            :master_timeout,
+            :ignore_unavailable,
+            :allow_no_indices,
+            :expand_wildcards ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/indices/delete_alias.rb

@@ -20,16 +20,19 @@ module Elasticsearch
         def delete_alias(arguments={})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
           raise ArgumentError, "Required argument 'name' missing"  unless arguments[:name]
-          valid_params = [ :timeout ]
-
           method = HTTP_DELETE
           path   = Utils.__pathify Utils.__escape(arguments[:index]), '_alias', Utils.__escape(arguments[:name])
 
-          params = Utils.__validate_and_extract_params arguments, valid_params
+          params = 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 6.2.0
+        ParamsRegistry.register(:delete_alias, [ :timeout ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/indices/delete_template.rb

@@ -20,12 +20,10 @@ module Elasticsearch
         #
         def delete_template(arguments={})
           raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
-          valid_params = [ :timeout ]
-
           method = HTTP_DELETE
           path   = Utils.__pathify '_template', Utils.__escape(arguments[:name])
 
-          params = Utils.__validate_and_extract_params arguments, valid_params
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           body = nil
 
           if Array(arguments[:ignore]).include?(404)
@@ -34,6 +32,11 @@ module Elasticsearch
             perform_request(method, path, params, body).body
           end
         end
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.2.0
+        ParamsRegistry.register(:delete_template, [ :timeout ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/indices/exists.rb

@@ -28,26 +28,26 @@ module Elasticsearch
         #
         def exists(arguments={})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
-
-          valid_params = [
-            :ignore_indices,
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards,
-            :local
-          ]
-
           method = HTTP_HEAD
           path   = Utils.__listify(arguments[:index])
-          params = Utils.__validate_and_extract_params arguments, valid_params
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           body   = nil
 
           Utils.__rescue_from_not_found do
             perform_request(method, path, params, body).status == 200 ? true : false
           end
         end
-
         alias_method :exists?, :exists
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.2.0
+        ParamsRegistry.register(:exists, [
+            :ignore_indices,
+            :ignore_unavailable,
+            :allow_no_indices,
+            :expand_wildcards,
+            :local ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/indices/exists_alias.rb

@@ -26,26 +26,27 @@ module Elasticsearch
         # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/
         #
         def exists_alias(arguments={})
-          valid_params = [
-            :ignore_indices,
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards,
-            :local
-          ]
-
           method = HTTP_HEAD
           path   = Utils.__pathify Utils.__listify(arguments[:index]), '_alias', Utils.__escape(arguments[:name])
 
-          params = Utils.__validate_and_extract_params arguments, valid_params
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           body = nil
 
           Utils.__rescue_from_not_found do
             perform_request(method, path, params, body).status == 200 ? true : false
           end
         end
-
         alias_method :exists_alias?, :exists_alias
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.2.0
+        ParamsRegistry.register(:exists_alias, [
+            :ignore_indices,
+            :ignore_unavailable,
+            :allow_no_indices,
+            :expand_wildcards,
+            :local ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/indices/exists_template.rb

@@ -15,20 +15,22 @@ module Elasticsearch
         #
         def exists_template(arguments={})
           raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
-          valid_params = [ :local, :master_timeout ]
-
           method = HTTP_HEAD
           path   = Utils.__pathify '_template', Utils.__escape(arguments[:name])
 
-          params = Utils.__validate_and_extract_params arguments, valid_params
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           body = nil
 
           Utils.__rescue_from_not_found do
             perform_request(method, path, params, body).status == 200 ? true : false
           end
         end
-
         alias_method :exists_template?, :exists_template
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.2.0
+        ParamsRegistry.register(:exists_template, [ :local, :master_timeout ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/indices/exists_type.rb

@@ -27,26 +27,27 @@ module Elasticsearch
         def exists_type(arguments={})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
           raise ArgumentError, "Required argument 'type' missing" unless arguments[:type]
-          valid_params = [
-            :ignore_indices,
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards,
-            :local
-          ]
-
           method = HTTP_HEAD
           path   = Utils.__pathify Utils.__listify(arguments[:index]), '_mapping', Utils.__escape(arguments[:type])
 
-          params = Utils.__validate_and_extract_params arguments, valid_params
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           body = nil
 
           Utils.__rescue_from_not_found do
             perform_request(method, path, params, body).status == 200 ? true : false
           end
         end
-
         alias_method :exists_type?, :exists_type
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.2.0
+        ParamsRegistry.register(:exists_type, [
+            :ignore_indices,
+            :ignore_unavailable,
+            :allow_no_indices,
+            :expand_wildcards,
+            :local ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/indices/flush.rb

@@ -24,21 +24,24 @@ module Elasticsearch
         # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-flush/
         #
         def flush(arguments={})
-          valid_params = [
-            :force,
-            :wait_if_ongoing,
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards ]
-
           method = HTTP_POST
           path   = Utils.__pathify Utils.__listify(arguments[:index]), '_flush'
 
-          params = Utils.__validate_and_extract_params arguments, valid_params
+          params = 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 6.2.0
+        ParamsRegistry.register(:flush, [
+            :force,
+            :wait_if_ongoing,
+            :ignore_unavailable,
+            :allow_no_indices,
+            :expand_wildcards ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/indices/flush_synced.rb

@@ -11,16 +11,10 @@ module Elasticsearch
         # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-flush.html
         #
         def flush_synced(arguments={})
-          valid_params = [
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards
-          ]
-
           method = HTTP_POST
           path   = Utils.__pathify Utils.__listify(arguments[:index]), '_flush/synced'
 
-          params = Utils.__validate_and_extract_params arguments, valid_params
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           body   = nil
 
           if Array(arguments[:ignore]).include?(404)
@@ -29,6 +23,14 @@ module Elasticsearch
             perform_request(method, path, params, body).body
           end
         end
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.2.0
+        ParamsRegistry.register(:flush_synced, [
+            :ignore_unavailable,
+            :allow_no_indices,
+            :expand_wildcards ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/indices/forcemerge.rb

@@ -42,20 +42,22 @@ module Elasticsearch
         # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-forcemerge.html
         #
         def forcemerge(arguments={})
-          valid_params = [
-            :max_num_segments,
-            :only_expunge_deletes,
-            :flush
-          ]
-
           method = HTTP_POST
           path   = Utils.__pathify Utils.__listify(arguments[:index]), '_forcemerge'
 
-          params = Utils.__validate_and_extract_params arguments, valid_params
+          params = 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 6.2.0
+        ParamsRegistry.register(:forcemerge, [
+            :max_num_segments,
+            :only_expunge_deletes,
+            :flush ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/indices/freeze.rb

@@ -0,0 +1,40 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # In order to keep indices available and queryable for a longer period but at the same time reduce their
+        #   hardware requirements they can be transitioned into a frozen state. Once an index is frozen, all of its
+        #   transient shard memory (aside from mappings and analyzers) is moved to persistent storage.
+        #
+        # @option arguments [List] :index A comma separated list of indices to freeze. (*Required*)
+        #
+        # @note This feature is available in the Platinum distribution of Elasticsearch.
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/frozen-indices.html
+        #
+        def freeze(arguments = {})
+          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+
+          valid_params = [
+              :timeout,
+              :master_timeout,
+              :ignore_unavailable,
+              :allow_no_indices,
+              :expand_wildcards,
+              :wait_for_active_shards]
+
+          arguments = arguments.clone
+          index = arguments.delete(:index)
+
+          method = Elasticsearch::API::HTTP_POST
+          path = Elasticsearch::API::Utils.__pathify Elasticsearch::API::Utils.__listify(index), '_freeze'
+          params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
+
+          perform_request(method, path, params).body
+        end
+      end
+    end
+  end
+end
+