elasticsearch-api 6.1.0 → 6.2.0

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

@@ -0,0 +1,39 @@
+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 unfreeze. (*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 unfreeze(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), '_unfreeze'
+          params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
+
+          perform_request(method, path, params).body
+        end
+      end
+    end
+  end
+end

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

@@ -32,16 +32,19 @@ module Elasticsearch
         #
         def update_aliases(arguments={})
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-          valid_params = [ :timeout ]
-
           method = HTTP_POST
           path   = "_aliases"
 
-          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(:update_aliases, [ :timeout ].freeze)
       end
     end
   end

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

@@ -19,19 +19,22 @@ module Elasticsearch
         # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-upgrade.html
         #
         def upgrade(arguments={})
-          valid_params = [
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards,
-            :wait_for_completion ]
-
           method = HTTP_POST
           path   = "_upgrade"
-          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(:upgrade, [
+            :ignore_unavailable,
+            :allow_no_indices,
+            :expand_wildcards,
+            :wait_for_completion ].freeze)
       end
     end
   end

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

@@ -66,7 +66,21 @@ module Elasticsearch
         # @see http://www.elasticsearch.org/guide/reference/api/validate/
         #
         def validate_query(arguments={})
-          valid_params = [
+          method = HTTP_GET
+          path   = Utils.__pathify Utils.__listify(arguments[:index]),
+                                   Utils.__listify(arguments[:type]),
+                                   '_validate/query'
+
+          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(:validate_query, [
             :rewrite,
             :explain,
             :ignore_unavailable,
@@ -79,18 +93,7 @@ module Elasticsearch
             :default_operator,
             :df,
             :lenient,
-            :lowercase_expanded_terms ]
-
-          method = HTTP_GET
-          path   = Utils.__pathify Utils.__listify(arguments[:index]),
-                                   Utils.__listify(arguments[:type]),
-                                   '_validate/query'
-
-          params = Utils.__validate_and_extract_params arguments, valid_params
-          body   = arguments[:body]
-
-          perform_request(method, path, params, body).body
-        end
+            :lowercase_expanded_terms ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb

@@ -13,16 +13,20 @@ module Elasticsearch
         #
         def delete_pipeline(arguments={})
           raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
-          valid_params = [
-            :master_timeout,
-            :timeout ]
           method = 'DELETE'
           path   = Utils.__pathify "_ingest/pipeline", Utils.__escape(arguments[:id])
-          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_pipeline, [
+            :master_timeout,
+            :timeout ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/ingest/get_pipeline.rb

@@ -11,15 +11,18 @@ module Elasticsearch
         # @see https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html
         #
         def get_pipeline(arguments={})
-          valid_params = [
-            :master_timeout ]
           method = 'GET'
           path   = Utils.__pathify "_ingest/pipeline", Utils.__escape(arguments[:id])
-          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(:get_pipeline, [ :master_timeout ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/ingest/params_registry.rb

@@ -0,0 +1,44 @@
+module Elasticsearch
+  module API
+    module Ingest
+      module Actions
+        module ParamsRegistry
+
+          extend self
+
+          # A Mapping of all the actions to their list of valid params.
+          #
+          # @since 6.2.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 6.2.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 6.2.0
+          def get(action)
+            PARAMS.fetch(action, [])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/ingest/put_pipeline.rb

@@ -15,17 +15,21 @@ module Elasticsearch
         def put_pipeline(arguments={})
           raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-          valid_params = [
-            :master_timeout,
-            :timeout ]
           method = 'PUT'
           path   = Utils.__pathify "_ingest/pipeline", Utils.__escape(arguments[:id])
 
-          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(:put_pipeline, [
+            :master_timeout,
+            :timeout ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/ingest/simulate.rb

@@ -14,15 +14,18 @@ module Elasticsearch
         #
         def simulate(arguments={})
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-          valid_params = [
-            :verbose ]
           method = 'GET'
           path   = Utils.__pathify "_ingest/pipeline", Utils.__escape(arguments[:id]), '_simulate'
-          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(:simulate, [ :verbose ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/mget.rb

@@ -46,31 +46,35 @@ module Elasticsearch
       #
       def mget(arguments={})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-
-        valid_params = [
-          :fields,
-          :parent,
-          :preference,
-          :realtime,
-          :refresh,
-          :routing,
-          :_source,
-          :_source_include,
-          :_source_exclude,
-          :stored_fields ]
-
         method = HTTP_GET
         path   = Utils.__pathify Utils.__escape(arguments[:index]),
                                  Utils.__escape(arguments[:type]),
                                  '_mget'
 
-        params = Utils.__validate_and_extract_params arguments, valid_params
+        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
         body   = arguments[:body]
 
         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(:mget, [
+          :fields,
+          :parent,
+          :preference,
+          :realtime,
+          :refresh,
+          :routing,
+          :_source,
+          :_source_include,
+          :_source_includes,
+          :_source_exclude,
+          :_source_excludes,
+          :stored_fields ].freeze)
     end
   end
 end

data/lib/elasticsearch/api/actions/mlt.rb

@@ -85,8 +85,27 @@ module Elasticsearch
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
         raise ArgumentError, "Required argument 'type' missing"  unless arguments[:type]
         raise ArgumentError, "Required argument 'id' missing"    unless arguments[:id]
+        method = HTTP_GET
+        path   = Utils.__pathify Utils.__escape(arguments[:index]),
+                                 Utils.__escape(arguments[:type]),
+                                 Utils.__escape(arguments[:id]),
+                                 '_mlt'
+
+        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+
+        [:mlt_fields, :search_indices, :search_types, :stop_words].each do |name|
+          params[name] = Utils.__listify(params[name]) if params[name]
+        end
+
+        body   = arguments[:body]
 
-        valid_params = [
+        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(:mlt, [
           :boost_terms,
           :max_doc_freq,
           :max_query_terms,
@@ -105,24 +124,7 @@ module Elasticsearch
           :search_source,
           :search_type,
           :search_types,
-          :stop_words ]
-
-        method = HTTP_GET
-        path   = Utils.__pathify Utils.__escape(arguments[:index]),
-                                 Utils.__escape(arguments[:type]),
-                                 Utils.__escape(arguments[:id]),
-                                 '_mlt'
-
-        params = Utils.__validate_and_extract_params arguments, valid_params
-
-        [:mlt_fields, :search_indices, :search_types, :stop_words].each do |name|
-          params[name] = Utils.__listify(params[name]) if params[name]
-        end
-
-        body   = arguments[:body]
-
-        perform_request(method, path, params, body).body
-      end
+          :stop_words ].freeze)
     end
   end
 end

data/lib/elasticsearch/api/actions/mpercolate.rb

@@ -31,16 +31,10 @@ module Elasticsearch
       #
       def mpercolate(arguments={})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-        valid_params = [
-          :ignore_unavailable,
-          :allow_no_indices,
-          :expand_wildcards,
-          :percolate_format ]
-
         method = HTTP_GET
         path   = "_mpercolate"
 
-        params = Utils.__validate_and_extract_params arguments, valid_params
+        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
         body   = arguments[:body]
 
         case
@@ -54,6 +48,15 @@ module Elasticsearch
 
         perform_request(method, path, params, payload).body
       end
+
+      # Register this action with its valid params when the module is loaded.
+      #
+      # @since 6.2.0
+      ParamsRegistry.register(:mpercolate, [
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards,
+          :percolate_format ].freeze)
     end
   end
 end

data/lib/elasticsearch/api/actions/msearch.rb

@@ -22,13 +22,13 @@ module Elasticsearch
       #         { query: { match_all: {} } },
       #         { index: 'myindex', type: 'mytype' },
       #         { query: { query_string: { query: '"Test 1"' } } },
-      #         { search_type: 'count' },
+      #         { search_type: 'query_then_fetch' },
       #         { aggregations: { published: { terms: { field: 'published' } } } }
       #       ]
       #
       # @option arguments [List] :index A comma-separated list of index names to use as default
       # @option arguments [List] :type A comma-separated list of document types to use as default
-      # @option arguments [Hash] :body The request definitions (metadata-search request definition pairs), separated by newlines (*Required*)
+      # @option arguments [Hash] :body The request definitions (metadata-search request definition pairs)
       # @option arguments [String] :search_type Search operation type (options: query_then_fetch, query_and_fetch, dfs_query_then_fetch, dfs_query_and_fetch)
       # @option arguments [Number] :max_concurrent_searches Controls the maximum number of concurrent searches the multi search api will execute
       # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
@@ -37,16 +37,10 @@ module Elasticsearch
       #
       def msearch(arguments={})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-
-         valid_params = [
-          :search_type,
-          :max_concurrent_searches,
-          :typed_keys ]
-
         method = HTTP_GET
         path   = Utils.__pathify( Utils.__listify(arguments[:index]), Utils.__listify(arguments[:type]), '_msearch' )
 
-        params = Utils.__validate_and_extract_params arguments, valid_params
+        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
         body   = arguments[:body]
 
         case
@@ -73,6 +67,16 @@ module Elasticsearch
 
         perform_request(method, path, params, payload, {"Content-Type" => "application/x-ndjson"}).body
       end
+
+      # Register this action with its valid params when the module is loaded.
+      #
+      # @since 6.2.0
+      ParamsRegistry.register(:msearch, [
+          :search_type,
+          :max_concurrent_searches,
+          :max_concurrent_shard_requests,
+          :typed_keys,
+          :rest_total_hits_as_int ].freeze)
     end
   end
 end