elasticsearch-api 6.8.0 → 7.10.0

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

@@ -1,30 +1,64 @@
+# 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
-
-        # The cluster nodes usage API allows to retrieve information on the usage of features for each node.
+        # Returns low-level information about REST actions usage on nodes.
         #
-        # @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      
+        # @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] :metric Limit the information returned to the specified metrics (options: _all, rest_actions)
+        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-usage.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/cluster-nodes-usage.html
         #
-        def usage(arguments={})
+        def usage(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _node_id = arguments.delete(:node_id)
+
+          _metric = arguments.delete(:metric)
+
           method = Elasticsearch::API::HTTP_GET
-          path   = "_nodes/usage"
-          params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
+          path   = if _node_id && _metric
+                     "_nodes/#{Utils.__listify(_node_id)}/usage/#{Utils.__listify(_metric)}"
+                   elsif _node_id
+                     "_nodes/#{Utils.__listify(_node_id)}/usage"
+                   elsif _metric
+                     "_nodes/usage/#{Utils.__listify(_metric)}"
+                   else
+                     "_nodes/usage"
+                   end
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
-          perform_request(method, path, params, body).body
+          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(:usage, [
-            :timeout ].freeze)
+          :timeout
+        ].freeze)
       end
     end
   end

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

@@ -1,13 +1,29 @@
+# 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.2.0
+        # @since 6.1.1
         PARAMS = {}
 
         # Register an action with its list of valid params.
@@ -18,7 +34,7 @@ module Elasticsearch
         # @param [ Symbol ] action The action to register.
         # @param [ Array[Symbol] ] valid_params The list of valid params.
         #
-        # @since 6.2.0
+        # @since 6.1.1
         def register(action, valid_params)
           PARAMS[action.to_sym] = valid_params
         end
@@ -32,7 +48,7 @@ module Elasticsearch
         #
         # @return [ Array<Symbol> ] The list of valid params for the action.
         #
-        # @since 6.2.0
+        # @since 6.1.1
         def get(action)
           PARAMS.fetch(action, [])
         end

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

@@ -1,37 +1,49 @@
+# 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
-
-      # Returns true if the cluster returns a successful HTTP response, false otherwise.
+      # Returns whether the cluster is running.
       #
-      # @example
+      # @option arguments [Hash] :headers Custom HTTP headers
       #
-      #     client.ping
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/index.html
       #
-      # @see http://elasticsearch.org/guide/
-      #
-      def ping(arguments={})
-        method = HTTP_HEAD
+      def ping(arguments = {})
+        headers = arguments.delete(:headers) || {}
+
+        arguments = arguments.clone
+
+        method = Elasticsearch::API::HTTP_HEAD
         path   = ""
         params = {}
-        body   = nil
 
+        body = nil
         begin
-          perform_request(method, path, params, body).status == 200 ? true : false
+        perform_request(method, path, params, body, headers).status == 200 ? true : false
         rescue Exception => e
-          if e.class.to_s =~ /NotFound|ConnectionFailed/ || e.message =~ /Not\s*Found|404|ConnectionFailed/i
+          if e.class.to_s =~ /NotFound|ConnectionFailed/ || e.message =~ /Not *Found|404|ConnectionFailed/i
             false
           else
             raise e
           end
-        end
       end
-
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.2.0
-      ParamsRegistry.register(:ping, [
-      ].freeze)
+      end
     end
   end
 end

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

@@ -1,53 +1,66 @@
+# 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
-
-      # Store a script in an internal index (`.scripts`), to be able to reference them
-      # in search definitions (with dynamic scripting disabled)
-      #
-      # @example Storing an Mvel script in Elasticsearch and using it in function score
-      #
-      #     client.put_script lang: 'groovy', id: 'my_score', body: { script: 'log(_score * factor)' }
+      # Creates or updates a script.
       #
-      #     client.search body: {
-      #       query: {
-      #         function_score: {
-      #           query: { match: { title: 'foo' } },
-      #           functions: [ { script_score: { script_id: 'my_score', params: { factor: 3 } } } ]
-      #         }
-      #       }
-      #     }
-      #
-      # @option arguments [String] :id Script ID (*Required*)
+      # @option arguments [String] :id Script ID
       # @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
+      # @option arguments [Hash] :headers Custom HTTP headers
+      # @option arguments [Hash] :body The document (*Required*)
       #
-      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-scripting.html#_indexed_scripts
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/modules-scripting.html
       #
-      def put_script(arguments={})
-        raise ArgumentError, "Required argument 'id' missing"   unless arguments[:id]
+      def put_script(arguments = {})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-        method = HTTP_PUT
-        path   = "_scripts/#{arguments.has_key?(:lang) ? "#{arguments.delete(:lang)}/" : ''}#{arguments[:id]}"
+        raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
 
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+        headers = arguments.delete(:headers) || {}
 
-        body   = arguments[:body]
+        arguments = arguments.clone
 
-        perform_request(method, path, params, body).body
-      end
+        _id = arguments.delete(:id)
+
+        _context = arguments.delete(:context)
 
+        method = Elasticsearch::API::HTTP_PUT
+        path   = if _id && _context
+                   "_scripts/#{Utils.__listify(_id)}/#{Utils.__listify(_context)}"
+                 else
+                   "_scripts/#{Utils.__listify(_id)}"
+                 end
+        params = 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(:put_script, [
-          :timeout,
-          :master_timeout,
-          :context ].freeze)
+        :timeout,
+        :master_timeout,
+        :context
+      ].freeze)
     end
   end
 end

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

@@ -1,36 +1,69 @@
+# 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.
+      # Allows to evaluate the quality of ranked search results over a set of typical search queries
+      # This functionality is Experimental and may be changed or removed
+      # completely in a future release. Elastic will take a best effort approach
+      # to fix any issues, but experimental features are not subject to the
+      # support SLA of official GA features.
       #
       # @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)
+      # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
+      # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch)
+      # @option arguments [Hash] :headers Custom HTTP headers
+      # @option arguments [Hash] :body The ranking evaluation search definition, including search requests, document ratings and ranking metric definition. (*Required*)
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-rank-eval.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/search-rank-eval.html
       #
-      def rank_eval(arguments={})
+      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
+        headers = arguments.delete(:headers) || {}
+
+        arguments = arguments.clone
+
+        _index = arguments.delete(:index)
+
+        method = Elasticsearch::API::HTTP_POST
+        path   = if _index
+                   "#{Utils.__listify(_index)}/_rank_eval"
+                 else
+                   "_rank_eval"
+                 end
+        params = 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(:rank_eval, [
-          :ignore_unavailable,
-          :allow_no_indices,
-          :expand_wildcards ].freeze)
+        :ignore_unavailable,
+        :allow_no_indices,
+        :expand_wildcards,
+        :search_type
+      ].freeze)
     end
   end
 end

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

@@ -1,71 +1,68 @@
+# 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
-
-      # Copy documents from one index to another, potentially changing
-      # its settings, mappings and the documents itself.
-      #
-      # @example Copy documents into a different index
-      #
-      #     client.reindex body: { source: { index: 'test1' }, dest: { index: 'test2' } }
-      #
-      # @example Limit the copied documents with a query
-      #
-      #     client.reindex body: {
-      #       source: {
-      #         index: 'test1',
-      #         query: { terms: { category: ['one', 'two'] }  }
-      #       },
-      #       dest: {
-      #         index: 'test2'
-      #       }
-      #     }
-      #
-      # @example Remove a field from reindexed documents
+      # Allows to copy documents from one index to another, optionally filtering the source
+      # documents by a query, changing the destination index settings, or fetching the
+      # documents from a remote cluster.
       #
-      #     client.reindex body: {
-      #       source: {
-      #         index: 'test1'
-      #       },
-      #       dest: {
-      #         index: 'test3'
-      #       },
-      #       script: {
-      #         inline: 'ctx._source.remove("category")'
-      #       }
-      #     }
-      #
-      # @option arguments [Hash] :body The search definition using the Query DSL and the prototype for the index request. (*Required*)
-      # @option arguments [Boolean] :refresh Should the effected indexes be refreshed?
+      # @option arguments [Boolean] :refresh Should the affected indexes be refreshed?
       # @option arguments [Time] :timeout Time each individual bulk request should wait for shards that are unavailable.
       # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the reindex operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
       # @option arguments [Boolean] :wait_for_completion Should the request should block until the reindex is complete.
       # @option arguments [Number] :requests_per_second The throttle to set on this request in sub-requests per second. -1 means no throttle.
-      # @option arguments [Number] :slices The number of slices this task should be divided into. Defaults to 1 meaning the task isn't sliced into subtasks.
-      #
+      # @option arguments [Time] :scroll Control how long to keep the search context alive
+      # @option arguments [Number|string] :slices The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`.
+      # @option arguments [Number] :max_docs Maximum number of documents to process (default: all documents)
+      # @option arguments [Hash] :headers Custom HTTP headers
+      # @option arguments [Hash] :body The search definition using the Query DSL and the prototype for the index request. (*Required*)
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/docs-reindex.html
       #
-      def reindex(arguments={})
+      def reindex(arguments = {})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-        method = 'POST'
+
+        headers = arguments.delete(:headers) || {}
+
+        arguments = arguments.clone
+
+        method = Elasticsearch::API::HTTP_POST
         path   = "_reindex"
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body   = arguments[:body]
 
-        perform_request(method, path, params, body).body
+        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(:reindex, [
-          :refresh,
-          :timeout,
-          :wait_for_active_shards,
-          :wait_for_completion,
-          :requests_per_second,
-          :slices ].freeze)
+        :refresh,
+        :timeout,
+        :wait_for_active_shards,
+        :wait_for_completion,
+        :requests_per_second,
+        :scroll,
+        :slices,
+        :max_docs
+      ].freeze)
     end
   end
 end

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

@@ -1,29 +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 Actions
-
-      # The value of requests_per_second can be changed on a running reindex using the _rethrottle
+      # Changes the number of requests per second for a particular Reindex operation.
       #
-      # @option arguments [String] :task_id The task id to rethrottle (*Required*)
-      # @option arguments [Number] :requests_per_second The throttle to set on this request in floating sub-requests per second. -1 means set no throttle.
+      # @option arguments [String] :task_id The task id to rethrottle
+      # @option arguments [Number] :requests_per_second The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. (*Required*)
+      # @option arguments [Hash] :headers Custom HTTP headers
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/docs-reindex.html
       #
-      def reindex_rethrottle(arguments={})
+      def reindex_rethrottle(arguments = {})
         raise ArgumentError, "Required argument 'task_id' missing" unless arguments[:task_id]
+
+        headers = arguments.delete(:headers) || {}
+
+        arguments = arguments.clone
+
+        _task_id = arguments.delete(:task_id)
+
         method = Elasticsearch::API::HTTP_POST
-        path   = "_reindex/#{arguments[:task_id]}/_rethrottle"
-        params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body   = nil
+        path   = "_reindex/#{Utils.__listify(_task_id)}/_rethrottle"
+        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
-        perform_request(method, path, params, body).body
+        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(:reindex_rethrottle, [
-          :requests_per_second ].freeze)
+        :requests_per_second
+      ].freeze)
     end
   end
 end

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

@@ -1,13 +1,29 @@
+# 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 Remote
       module Actions
-
         # Returns all of the configured remote cluster information
         #
         # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/remote-info.html
         #
-        def info(arguments={})
+        def info(arguments = {})
           method = HTTP_GET
           path   = "_remote/info"
           params = {}