elasticsearch-api 6.0.1 → 7.0.0

data/lib/elasticsearch/api/actions/nodes/info.rb

@@ -1,3 +1,20 @@
+# 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 API
     module Nodes
@@ -43,37 +60,41 @@ module Elasticsearch
         def info(arguments={})
           arguments = arguments.clone
           metric    = arguments.delete(:metric)
-
-          valid_parts = [
-            :_all,
-            :http,
-            :jvm,
-            :network,
-            :os,
-            :plugins,
-            :process,
-            :settings,
-            :thread_pool,
-            :transport,
-            :timeout ]
-
-          valid_params = [ :flat_settings, :timeout ]
-
           method = HTTP_GET
-
           if metric
             parts = metric
           else
-            parts = Utils.__extract_parts arguments, valid_parts
+            parts = Utils.__extract_parts arguments, ParamsRegistry.get(:info_parts)
           end
 
           path   = Utils.__pathify '_nodes', Utils.__listify(arguments[:node_id]), Utils.__listify(parts)
 
-          params = Utils.__validate_and_extract_params arguments, valid_params
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(:info_params)
           body   = nil
 
           perform_request(method, path, params, body).body
         end
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.1.1
+        ParamsRegistry.register(:info_params, [ :flat_settings, :timeout ].freeze)
+
+        # Register this action with its valid parts when the module is loaded.
+        #
+        # @since 6.1.1
+        ParamsRegistry.register(:info_parts, [
+            :_all,
+            :http,
+            :jvm,
+            :network,
+            :os,
+            :plugins,
+            :process,
+            :settings,
+            :thread_pool,
+            :transport,
+            :timeout ].freeze)
       end
     end
   end

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

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

data/lib/elasticsearch/api/actions/nodes/reload_secure_settings.rb

@@ -0,0 +1,54 @@
+# 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 API
+    module Nodes
+      module Actions
+
+        # Re-read the local node's encrypted keystore. Specifically, it will prompt the keystore
+        # decryption and reading across the cluster.
+        #
+        # @example Reload secure settings for all nodes
+        #
+        #     client.nodes.reload_secure_settings
+        #
+        # @example Reload secure settings for a list of nodes
+        #
+        #     client.nodes.reload_secure_settings(node_id: 'foo,bar')
+        #
+        # @option arguments [ Array ] :node_id A comma-separated list of node IDs or names to perform the operation on
+        # @option arguments [ String ] :timeout Explicit operation timeout
+        #
+        # @see http://elasticsearch.org/guide/reference/api/cluster-nodes-reload-secure-settings
+        #
+        def reload_secure_settings(arguments={})
+          valid_params = [
+              :timeout ]
+
+          method = HTTP_POST
+          path   = Utils.__pathify '_nodes', Utils.__listify(arguments[:node_id]), 'reload_secure_settings'
+
+          params = Utils.__validate_and_extract_params arguments, valid_params
+          body   = nil
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/nodes/shutdown.rb

@@ -1,3 +1,20 @@
+# 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 API
     module Nodes
@@ -18,18 +35,21 @@ module Elasticsearch
         # @see http://elasticsearch.org/guide/reference/api/admin-cluster-nodes-shutdown/
         #
         def shutdown(arguments={})
-          valid_params = [
-            :delay,
-            :exit ]
-
           method = HTTP_POST
           path   = Utils.__pathify '_cluster/nodes', Utils.__listify(arguments[:node_id]), '_shutdown'
 
-          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.1.1
+        ParamsRegistry.register(:shutdown, [
+            :delay,
+            :exit ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/nodes/stats.rb

@@ -1,3 +1,20 @@
+# 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 API
     module Nodes
@@ -13,52 +30,22 @@ module Elasticsearch
         #
         #     client.nodes.stats metric: 'indices', index_metric: 'fielddata', fields: '*', human: true
         #
-        # @option arguments [List] :metric Limit the information returned to the specified metrics
-        #                                  (options: _all, breaker, fs, http, indices, jvm, network,
-        #                                  os, process, thread_pool, transport)
-        # @option arguments [List] :index_metric Limit the information returned for the `indices` metric
-        #                                        to the specified index metrics. Used only when
-        #                                        `indices` or `all` metric is specified.
-        #                                  (options: _all, completion, docs, fielddata, filter_cache, flush, get,
-        #                                  id_cache, indexing, merge, percolate, refresh, search, segments, store,
-        #                                  warmer)
-        # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit
-        #                                   the returned information; use `_local` to return information
-        #                                   from the node you're connecting to, leave empty to get information
-        #                                   from all nodes
-        # @option arguments [List] :completion_fields A comma-separated list of fields for `fielddata` and `suggest`
-        #                                             index metrics (supports wildcards)
-        # @option arguments [List] :fielddata_fields A comma-separated list of fields for `fielddata` index metric
-        #                                            (supports wildcards)
-        # @option arguments [List] :fields A comma-separated list of fields for `fielddata` and `completion` index
-        #                                  metrics (supports wildcards)
-        # @option arguments [Boolean] :include_segment_file_sizes Whether to report the aggregated disk usage of each one of the Lucene index files. Only applies if segment stats are requested. (default: false)
+        # @option arguments [List] :metric Limit the information returned to the specified metrics (options: _all,breaker,fs,http,indices,jvm,os,process,thread_pool,transport,discovery)
+        # @option arguments [List] :index_metric Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified. (options: _all,completion,docs,fielddata,query_cache,flush,get,indexing,merge,request_cache,refresh,search,segments,store,warmer,suggest)
+        # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
+        # @option arguments [List] :completion_fields A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
+        # @option arguments [List] :fielddata_fields A comma-separated list of fields for `fielddata` index metric (supports wildcards)
+        # @option arguments [List] :fields A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)
         # @option arguments [Boolean] :groups A comma-separated list of search groups for `search` index metric
-        # @option arguments [Boolean] :human Whether to return time and byte values in human-readable format
-        # @option arguments [String] :level Specify the level for aggregating indices stats
-        #                                   (options: node, indices, shards)
+        # @option arguments [String] :level Return indices stats aggregated at index, node or shard level (options: indices, node, shards)
         # @option arguments [List] :types A comma-separated list of document types for the `indexing` index metric
         # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [Boolean] :include_segment_file_sizes Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested)
         #
         # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cluster-nodes-stats.html
         #
         def stats(arguments={})
           arguments = arguments.clone
-
-          valid_params = [
-            :metric,
-            :index_metric,
-            :node_id,
-            :completion_fields,
-            :fielddata_fields,
-            :fields,
-            :include_segment_file_sizes,
-            :groups,
-            :human,
-            :level,
-            :types,
-            :timeout ]
-
           node_id = arguments.delete(:node_id)
 
           path   = Utils.__pathify '_nodes',
@@ -67,7 +54,7 @@ module Elasticsearch
                                    Utils.__listify(arguments.delete(:metric)),
                                    Utils.__listify(arguments.delete(:index_metric))
 
-          params = Utils.__validate_and_extract_params arguments, valid_params
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           [:completion_fields, :fielddata_fields, :fields, :groups, :types].each do |key|
             params[key] = Utils.__listify(params[key]) if params[key]
@@ -77,6 +64,19 @@ module Elasticsearch
 
           perform_request(HTTP_GET, path, params, body).body
         end
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.1.1
+        ParamsRegistry.register(:stats, [
+            :completion_fields,
+            :fielddata_fields,
+            :fields,
+            :groups,
+            :level,
+            :types,
+            :timeout,
+            :include_segment_file_sizes ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/nodes/usage.rb

@@ -0,0 +1,31 @@
+module Elasticsearch
+  module API
+    module Nodes
+      module Actions
+
+        # The cluster nodes usage API allows to retrieve information on the usage of features for each node.
+        #
+        # @option arguments [List] :metric Limit the information returned to the specified metrics (options: _all,rest_actions)
+        # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
+        # @option arguments [Time] :timeout Explicit operation timeout
+        #
+        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-usage.html
+        #
+        def usage(arguments={})
+          method = Elasticsearch::API::HTTP_GET
+          path   = "_nodes/usage"
+          params = Elasticsearch::API::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(:usage, [
+            :timeout ].freeze)
+      end
+    end
+  end
+end

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

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

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

@@ -1,3 +1,20 @@
+# 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 API
     module Actions

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

@@ -1,3 +1,20 @@
+# 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 API
     module Actions
@@ -19,33 +36,34 @@ module Elasticsearch
       #     }
       #
       # @option arguments [String] :id Script ID (*Required*)
-      # @option arguments [String] :lang Script language (*Required*)
-      # @option arguments [Hash]   :body A JSON document containing the script (*Required*)
-      # @option arguments [Number] :version Explicit version number for concurrency control
-      # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte, force)
-      # @option arguments [String] :op_type Explicit operation type (options: index, create)
+      # @option arguments [String] :context Script context
+      # @option arguments [Hash] :body The document (*Required*)
+      # @option arguments [Time] :timeout Explicit operation timeout
+      # @option arguments [Time] :master_timeout Specify timeout for connection to master
+      # @option arguments [String] :context Context name to compile script against
       #
       # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-scripting.html#_indexed_scripts
       #
       def put_script(arguments={})
         raise ArgumentError, "Required argument 'id' missing"   unless arguments[:id]
-        raise ArgumentError, "Required argument 'lang' missing" unless arguments[:lang]
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-
-        valid_params = [
-          :op_type,
-          :version,
-          :version_type ]
-
         method = HTTP_PUT
-        path   = "_scripts/#{arguments.delete(:lang)}/#{arguments[:id]}"
+        path   = "_scripts/#{arguments.has_key?(:lang) ? "#{arguments.delete(:lang)}/" : ''}#{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.1.1
+      ParamsRegistry.register(:put_script, [
+          :timeout,
+          :master_timeout,
+          :context ].freeze)
     end
   end
 end

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

@@ -0,0 +1,53 @@
+# 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 API
+    module Actions
+
+      # The ranking evaluation API allows to evaluate the quality of ranked search results over a set of typical search queries.
+      #   Given this set of queries and a list of manually rated documents, the _rank_eval endpoint calculates and
+      #   returns typical information retrieval metrics like mean reciprocal rank, precision or discounted cumulative gain.
+      #
+      # @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 [Hash] :body The ranking evaluation search definition, including search requests, document ratings and ranking metric definition. (*Required*)
+      # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
+      # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
+      # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, none, all)
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-rank-eval.html
+      #
+      def rank_eval(arguments={})
+        raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+        method = Elasticsearch::API::HTTP_GET
+        path   = "_rank_eval"
+        params = Elasticsearch::API::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(:rank_eval, [
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards ].freeze)
+    end
+  end
+end