elasticsearch-api 6.8.0 → 7.10.0

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

@@ -1,35 +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 Ingest
       module Actions
-
-        # Add or update a specified pipeline
+        # Creates or updates a pipeline.
         #
-        # @option arguments [String] :id Pipeline ID (*Required*)
-        # @option arguments [Hash] :body The ingest definition (*Required*)
+        # @option arguments [String] :id Pipeline ID
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The ingest definition (*Required*)
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/plugins/current/ingest.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/put-pipeline-api.html
         #
-        def put_pipeline(arguments={})
-          raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+        def put_pipeline(arguments = {})
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-          method = 'PUT'
-          path   = Utils.__pathify "_ingest/pipeline", Utils.__escape(arguments[:id])
+          raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _id = arguments.delete(:id)
 
+          method = Elasticsearch::API::HTTP_PUT
+          path   = "_ingest/pipeline/#{Utils.__listify(_id)}"
           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(:put_pipeline, [
-            :master_timeout,
-            :timeout ].freeze)
+          :master_timeout,
+          :timeout
+        ].freeze)
       end
     end
   end

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

@@ -1,31 +1,60 @@
+# 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 Ingest
       module Actions
-
-        # Execute a specific pipeline against the set of documents provided in the body of the request
+        # Allows to simulate a pipeline with example documents.
         #
         # @option arguments [String] :id Pipeline ID
-        # @option arguments [Hash] :body The simulate definition (*Required*)
         # @option arguments [Boolean] :verbose Verbose mode. Display data output for each processor in executed pipeline
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The simulate definition (*Required*)
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/plugins/current/ingest.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/simulate-pipeline-api.html
         #
-        def simulate(arguments={})
+        def simulate(arguments = {})
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-          method = 'GET'
-          path   = Utils.__pathify "_ingest/pipeline", Utils.__escape(arguments[:id]), '_simulate'
+
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _id = arguments.delete(:id)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = if _id
+                     "_ingest/pipeline/#{Utils.__listify(_id)}/_simulate"
+                   else
+                     "_ingest/pipeline/_simulate"
+                   end
           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(:simulate, [
-            :verbose ].freeze)
+          :verbose
+        ].freeze)
       end
     end
   end

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

@@ -1,33 +1,27 @@
+# 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
-
-      # Return multiple documents from one or more indices in a single request.
-      #
-      # Pass the request definition in the `:body` argument, either as an Array of `docs` specifications,
-      # or `ids`, when the `:index` and document `:type` are specified.
-      #
-      # @example Get multiple documents fully specified in the `docs` definition
-      #
-      #     client.mget body: {
-      #       docs: [
-      #         { _index: 'myindex', _type: 'mytype', _id: '1' },
-      #         { _index: 'myindex', _type: 'mytype', _id: '2' },
-      #         { _index: 'myindex', _type: 'mytype', _id: '3' }
-      #       ]
-      #     }
-      #
-      # @example Get multiple documents specified by `ids` while passing `:index` and `:type`
-      #
-      #     client.mget index: 'myindex', type: 'mytype', body: { ids: ['1', '2', '3'] }
-      #
-      # @example Get only specific fields from documents
-      #
-      #     client.mget index: 'myindex', type: 'mytype', body: { ids: ['1', '2', '3'] }, fields: ['title']
+      # Allows to get multiple documents in one request.
       #
       # @option arguments [String] :index The name of the index
-      # @option arguments [String] :type The type of the document
-      # @option arguments [Hash] :body Document identifiers; can be either `docs` (containing full document information) or `ids` (when index and type is provided in the URL. (*Required*)
+      # @option arguments [String] :type The type of the document *Deprecated*
       # @option arguments [List] :stored_fields A comma-separated list of stored fields to return in the response
       # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
       # @option arguments [Boolean] :realtime Specify whether to perform the operation in realtime or search mode
@@ -36,36 +30,54 @@ module Elasticsearch
       # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return
       # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field
       # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field
+      # @option arguments [Hash] :headers Custom HTTP headers
+      # @option arguments [Hash] :body Document identifiers; can be either `docs` (containing full document information) or `ids` (when index and type is provided in the URL. (*Required*)
+      #
+      # *Deprecation notice*:
+      # Specifying types in urls has been deprecated
+      # Deprecated since version 7.0.0
       #
-      # @see http://elasticsearch.org/guide/reference/api/multi-get/
       #
-      def mget(arguments={})
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/docs-multi-get.html
+      #
+      def mget(arguments = {})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-        method = HTTP_GET
-        path   = Utils.__pathify Utils.__escape(arguments[:index]),
-                                 Utils.__escape(arguments[:type]),
-                                 '_mget'
 
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body   = arguments[:body]
+        headers = arguments.delete(:headers) || {}
 
-        params[:fields] = Utils.__listify(params[:fields]) if params[:fields]
+        arguments = arguments.clone
+
+        _index = arguments.delete(:index)
+
+        _type = arguments.delete(:type)
+
+        method = Elasticsearch::API::HTTP_POST
+        path   = if _index && _type
+                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_mget"
+                 elsif _index
+                   "#{Utils.__listify(_index)}/_mget"
+                 else
+                   "_mget"
+                 end
+        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
-        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(:mget, [
-          :stored_fields,
-          :preference,
-          :realtime,
-          :refresh,
-          :routing,
-          :_source,
-          :_source_excludes,
-          :_source_includes ].freeze)
+        :stored_fields,
+        :preference,
+        :realtime,
+        :refresh,
+        :routing,
+        :_source,
+        :_source_excludes,
+        :_source_includes
+      ].freeze)
     end
   end
 end

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

@@ -1,63 +1,78 @@
+# 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
-
-      # Perform multiple search operations in a single request.
-      #
-      # Pass the search definitions in the `:body` argument
-      #
-      # @example Perform multiple different searches as `:search`
-      #
-      #     client.msearch \
-      #       body: [
-      #         { search: { query: { match_all: {} } } },
-      #         { index: 'myindex', type: 'mytype', search: { query: { query_string: { query: '"Test 1"' } } } },
-      #         { search_type: 'count', search: { aggregations: { published: { terms: { field: 'published' } } } } }
-      #       ]
-      #
-      # @example Perform multiple different searches as an array of meta/data pairs
-      #
-      #     client.msearch \
-      #       body: [
-      #         { query: { match_all: {} } },
-      #         { index: 'myindex', type: 'mytype' },
-      #         { query: { query_string: { query: '"Test 1"' } } },
-      #         { search_type: 'query_then_fetch' },
-      #         { aggregations: { published: { terms: { field: 'published' } } } }
-      #       ]
+      # Allows to execute several search operations in one request.
       #
       # @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 [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
-      # @option arguments [Number] :pre_filter_shard_size A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on it's rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.
-      # @option arguments [Number] :max_concurrent_shard_requests The number of concurrent shard requests each sub search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
-      # @option arguments [Boolean] :rest_total_hits_as_int This parameter is ignored in this version. It is used in the next major version to control whether the rest response should render the total.hits as an object or a number
+      # @option arguments [Number] :pre_filter_shard_size A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.
+      # @option arguments [Number] :max_concurrent_shard_requests The number of concurrent shard requests each sub search executes concurrently per node. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
+      # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response
+      # @option arguments [Boolean] :ccs_minimize_roundtrips Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
+      # @option arguments [Hash] :headers Custom HTTP headers
+      # @option arguments [Hash] :body The request definitions (metadata-search request definition pairs), separated by newlines (*Required*)
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-multi-search.html
+      # *Deprecation notice*:
+      # Specifying types in urls has been deprecated
+      # Deprecated since version 7.0.0
       #
-      def msearch(arguments={})
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/search-multi-search.html
+      #
+      def msearch(arguments = {})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-        method = HTTP_GET
-        path   = Utils.__pathify( Utils.__listify(arguments[:index]), Utils.__listify(arguments[:type]), '_msearch' )
 
+        headers = arguments.delete(:headers) || {}
+
+        arguments = arguments.clone
+
+        _index = arguments.delete(:index)
+
+        _type = arguments.delete(:type)
+
+        method = Elasticsearch::API::HTTP_POST
+        path   = if _index && _type
+                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_msearch"
+                 elsif _index
+                   "#{Utils.__listify(_index)}/_msearch"
+                 else
+                   "_msearch"
+                 end
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body   = arguments[:body]
 
+        body = arguments[:body]
         case
         when body.is_a?(Array) && body.any? { |d| d.has_key? :search }
-          payload = body.
-            inject([]) do |sum, item|
-              meta = item
-              data = meta.delete(:search)
+          payload = body
+                    .inject([]) do |sum, item|
+                      meta = item
+                      data = meta.delete(:search)
 
-              sum << meta
-              sum << data
-              sum
-            end.
-            map { |item| Elasticsearch::API.serializer.dump(item) }
+                      sum << meta
+                      sum << data
+                      sum
+                    end
+                    .map { |item| Elasticsearch::API.serializer.dump(item) }
           payload << "" unless payload.empty?
           payload = payload.join("\n")
         when body.is_a?(Array)
@@ -68,20 +83,22 @@ module Elasticsearch
           payload = body
         end
 
-        perform_request(method, path, params, payload, {"Content-Type" => "application/x-ndjson"}).body
+        headers.merge!("Content-Type" => "application/x-ndjson")
+        perform_request(method, path, params, payload, headers).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,
-          :typed_keys,
-          :pre_filter_shard_size,
-          :max_concurrent_shard_requests,
-          :rest_total_hits_as_int ].freeze)
+        :search_type,
+        :max_concurrent_searches,
+        :typed_keys,
+        :pre_filter_shard_size,
+        :max_concurrent_shard_requests,
+        :rest_total_hits_as_int,
+        :ccs_minimize_roundtrips
+      ].freeze)
     end
   end
 end

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

@@ -1,55 +1,88 @@
+# 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
-
-      # Execute several search requests using templates (inline, indexed or stored in a file)
-      #
-      # @example Search with an inline script
-      #
-      #     client.msearch_template body: [
-      #       { index: 'test' },
-      #       { inline: { query: { match: { title: '{{q}}' } } }, params: { q: 'foo'} }
-      #     ]
+      # Allows to execute several search template operations in one request.
       #
       # @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 [String] :search_type Search operation type (options: query_then_fetch, query_and_fetch, dfs_query_then_fetch, dfs_query_and_fetch)
       # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
       # @option arguments [Number] :max_concurrent_searches Controls the maximum number of concurrent searches the multi search api will execute
-      # @option arguments [Boolean] :rest_total_hits_as_int This parameter is ignored in this version. It is used in the next major version to control whether the rest response should render the total.hits as an object or a number
+      # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response
+      # @option arguments [Boolean] :ccs_minimize_roundtrips Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
+      # @option arguments [Hash] :headers Custom HTTP headers
+      # @option arguments [Hash] :body The request definitions (metadata-search request definition pairs), separated by newlines (*Required*)
+      #
+      # *Deprecation notice*:
+      # Specifying types in urls has been deprecated
+      # Deprecated since version 7.0.0
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/multi-search-template.html
       #
-      def msearch_template(arguments={})
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/search-multi-search.html
+      #
+      def msearch_template(arguments = {})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-        method = HTTP_GET
-        path   = Utils.__pathify Utils.__listify(arguments[:index]),
-                                 Utils.__listify(arguments[:type]),
-                                 '_msearch/template'
+
+        headers = arguments.delete(:headers) || {}
+
+        arguments = arguments.clone
+
+        _index = arguments.delete(:index)
+
+        _type = arguments.delete(:type)
+
+        method = Elasticsearch::API::HTTP_POST
+        path   = if _index && _type
+                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_msearch/template"
+                 elsif _index
+                   "#{Utils.__listify(_index)}/_msearch/template"
+                 else
+                   "_msearch/template"
+                 end
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body   = arguments[:body]
 
+        body = arguments[:body]
         case
-          when body.is_a?(Array)
-            payload = body.map { |d| d.is_a?(String) ? d : Elasticsearch::API.serializer.dump(d) }
-            payload << "" unless payload.empty?
-            payload = payload.join("\n")
-          else
-            payload = body
+        when body.is_a?(Array)
+          payload = body.map { |d| d.is_a?(String) ? d : Elasticsearch::API.serializer.dump(d) }
+          payload << "" unless payload.empty?
+          payload = payload.join("
+")
+        else
+          payload = body
         end
 
-        perform_request(method, path, params, payload, {"Content-Type" => "application/x-ndjson"}).body
+        headers.merge!("Content-Type" => "application/x-ndjson")
+        perform_request(method, path, params, payload, headers).body
       end
 
       # Register this action with its valid params when the module is loaded.
       #
       # @since 6.2.0
       ParamsRegistry.register(:msearch_template, [
-          :search_type,
-          :typed_keys,
-          :max_concurrent_searches,
-          :rest_total_hits_as_int ].freeze)
+        :search_type,
+        :typed_keys,
+        :max_concurrent_searches,
+        :rest_total_hits_as_int,
+        :ccs_minimize_roundtrips
+      ].freeze)
     end
   end
 end