elasticsearch-api 7.14.0 → 8.0.0.pre1

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

@@ -21,7 +21,6 @@ module Elasticsearch
       # 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 *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
@@ -31,53 +30,33 @@ module Elasticsearch
       # @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*)
+      # @option arguments [Hash] :body Document identifiers; can be either `docs` (containing full document information) or `ids` (when index is provided in the URL. (*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/7.14/docs-multi-get.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html
       #
       def mget(arguments = {})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
 
         headers = arguments.delete(:headers) || {}
 
+        body = arguments.delete(:body)
+
         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
+        path   = if _index
                    "#{Utils.__listify(_index)}/_mget"
                  else
                    "_mget"
                  end
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+        params = Utils.process_params(arguments)
 
-        body = arguments[:body]
-        perform_request(method, path, params, body, headers).body
+        Elasticsearch::API::Response.new(
+          perform_request(method, path, params, body, headers)
+        )
       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)
     end
   end
 end

data/lib/elasticsearch/api/actions/migration/deprecations.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 Migration
+      module Actions
+        # Retrieves information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.
+        #
+        # @option arguments [String] :index Index pattern
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-deprecation.html
+        #
+        def deprecations(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _index
+                     "#{Utils.__listify(_index)}/_migration/deprecations"
+                   else
+                     "_migration/deprecations"
+                   end
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/migration/get_feature_upgrade_status.rb

@@ -0,0 +1,46 @@
+# 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 Migration
+      module Actions
+        # Find out whether system features need to be upgraded or not
+        #
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-feature-upgrade.html
+        #
+        def get_feature_upgrade_status(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = "_migration/system_features"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/migration/post_feature_upgrade.rb

@@ -0,0 +1,46 @@
+# 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 Migration
+      module Actions
+        # Begin upgrades for system features
+        #
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-feature-upgrade.html
+        #
+        def post_feature_upgrade(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_migration/system_features"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/monitoring/bulk.rb

@@ -0,0 +1,72 @@
+# 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 Monitoring
+      module Actions
+        # Used by the monitoring features to send monitoring data.
+        #
+        # @option arguments [String] :type Default document type for items which don't provide one *Deprecated*
+        # @option arguments [String] :system_id Identifier of the monitored system
+        # @option arguments [String] :system_api_version API Version of the monitored system
+        # @option arguments [String] :interval Collection interval (e.g., '10s' or '10000ms') of the payload
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [String|Array] :body The operation definition and data (action-data pairs), separated by newlines. Array of Strings, Header/Data pairs,
+        # or the conveniency "combined" format can be passed, refer to Elasticsearch::API::Utils.__bulkify documentation.
+        #
+        # *Deprecation notice*:
+        # Specifying types in urls has been deprecated
+        # Deprecated since version 7.0.0
+        #
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/monitor-elasticsearch-cluster.html
+        #
+        def bulk(arguments = {})
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          arguments = arguments.clone
+
+          _type = arguments.delete(:type)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = if _type
+                     "_monitoring/#{Utils.__listify(_type)}/bulk"
+                   else
+                     "_monitoring/bulk"
+                   end
+          params = Utils.process_params(arguments)
+
+          if body.is_a? Array
+            payload = Elasticsearch::API::Utils.__bulkify(body)
+          else
+            payload = body
+          end
+
+          headers.merge!("Content-Type" => "application/x-ndjson")
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, payload, headers)
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -21,7 +21,6 @@ module Elasticsearch
       # 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 [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_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
@@ -32,35 +31,27 @@ module Elasticsearch
       # @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/7.14/search-multi-search.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html
       #
       def msearch(arguments = {})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
 
         headers = arguments.delete(:headers) || {}
 
+        body = arguments.delete(:body)
+
         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
+        path   = if _index
                    "#{Utils.__listify(_index)}/_msearch"
                  else
                    "_msearch"
                  end
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+        params = Utils.process_params(arguments)
 
-        body = arguments[:body]
         case
         when body.is_a?(Array) && body.any? { |d| d.has_key? :search }
           payload = body
@@ -84,21 +75,10 @@ module Elasticsearch
         end
 
         headers.merge!("Content-Type" => "application/x-ndjson")
-        perform_request(method, path, params, payload, headers).body
+        Elasticsearch::API::Response.new(
+          perform_request(method, path, params, payload, headers)
+        )
       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,
-        :ccs_minimize_roundtrips
-      ].freeze)
     end
   end
 end

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

@@ -21,7 +21,6 @@ module Elasticsearch
       # 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 [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_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
@@ -30,35 +29,27 @@ module Elasticsearch
       # @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/7.14/search-multi-search.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html
       #
       def msearch_template(arguments = {})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
 
         headers = arguments.delete(:headers) || {}
 
+        body = arguments.delete(:body)
+
         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
+        path   = if _index
                    "#{Utils.__listify(_index)}/_msearch/template"
                  else
                    "_msearch/template"
                  end
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+        params = Utils.process_params(arguments)
 
-        body = arguments[:body]
         case
         when body.is_a?(Array)
           payload = body.map { |d| d.is_a?(String) ? d : Elasticsearch::API.serializer.dump(d) }
@@ -70,19 +61,10 @@ module Elasticsearch
         end
 
         headers.merge!("Content-Type" => "application/x-ndjson")
-        perform_request(method, path, params, payload, headers).body
+        Elasticsearch::API::Response.new(
+          perform_request(method, path, params, payload, headers)
+        )
       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,
-        :ccs_minimize_roundtrips
-      ].freeze)
     end
   end
 end

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

@@ -21,7 +21,6 @@ module Elasticsearch
       # Returns multiple termvectors in one request.
       #
       # @option arguments [String] :index The index in which the document resides.
-      # @option arguments [String] :type The type of the document.
       # @option arguments [List] :ids A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body
       # @option arguments [Boolean] :term_statistics Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".
       # @option arguments [Boolean] :field_statistics Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".
@@ -33,67 +32,42 @@ module Elasticsearch
       # @option arguments [String] :routing Specific routing value. Applies to all returned documents unless otherwise specified in body "params" or "docs".
       # @option arguments [Boolean] :realtime Specifies if requests are real-time as opposed to near-real-time (default: true).
       # @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] :version_type Specific version type (options: internal, external, external_gte)
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation.
       #
-      # *Deprecation notice*:
-      # Specifying types in urls has been deprecated
-      # Deprecated since version 7.0.0
-      #
-      #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/docs-multi-termvectors.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html
       #
       def mtermvectors(arguments = {})
         headers = arguments.delete(:headers) || {}
 
+        body = if (ids = arguments.delete(:ids))
+                 { :ids => ids }
+               else
+                 arguments.delete(:body)
+               end
+
         arguments = arguments.clone
-        ids = arguments.delete(:ids)
 
         _index = arguments.delete(:index)
 
-        _type = arguments.delete(:type)
-
-        method = if arguments[:body]
+        method = if body
                    Elasticsearch::API::HTTP_POST
                  else
                    Elasticsearch::API::HTTP_GET
                  end
 
-        path   = if _index && _type
-                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_mtermvectors"
-                 elsif _index
+        path   = if _index
                    "#{Utils.__listify(_index)}/_mtermvectors"
                  else
                    "_mtermvectors"
                  end
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+        params = Utils.process_params(arguments)
 
-        if ids
-          body = { :ids => ids }
-        else
-          body = arguments[:body]
-        end
-        perform_request(method, path, params, body, headers).body
+        Elasticsearch::API::Response.new(
+          perform_request(method, path, params, body, headers)
+        )
       end
-
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.2.0
-      ParamsRegistry.register(:mtermvectors, [
-        :ids,
-        :term_statistics,
-        :field_statistics,
-        :fields,
-        :offsets,
-        :positions,
-        :payloads,
-        :preference,
-        :routing,
-        :realtime,
-        :version,
-        :version_type
-      ].freeze)
     end
   end
 end

data/lib/elasticsearch/api/actions/nodes/clear_repositories_metering_archive.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
+        # Removes the archived repositories metering information present in the cluster.
+        # 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] :node_id Comma-separated list of node IDs or names used to limit returned information.
+        # @option arguments [Long] :max_archive_version Specifies the maximum archive_version to be cleared from the archive.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-repositories-metering-archive-api.html
+        #
+        def clear_repositories_metering_archive(arguments = {})
+          raise ArgumentError, "Required argument 'node_id' missing" unless arguments[:node_id]
+
+          raise ArgumentError,
+                "Required argument 'max_archive_version' missing" unless arguments[:max_archive_version]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _node_id = arguments.delete(:node_id)
+
+          _max_archive_version = arguments.delete(:max_archive_version)
+
+          method = Elasticsearch::API::HTTP_DELETE
+          path   = "_nodes/#{Utils.__listify(_node_id)}/_repositories_metering/#{Utils.__listify(_max_archive_version)}"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# 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
+        # Returns cluster repositories metering information.
+        # 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] :node_id A comma-separated list of node IDs or names to limit the returned information.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-repositories-metering-api.html
+        #
+        def get_repositories_metering_info(arguments = {})
+          raise ArgumentError, "Required argument 'node_id' missing" unless arguments[:node_id]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _node_id = arguments.delete(:node_id)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = "_nodes/#{Utils.__listify(_node_id)}/_repositories_metering"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end