elasticsearch-api 7.13.3 → 8.14.0

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

@@ -0,0 +1,90 @@
+# 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.
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
+module Elasticsearch
+  module API
+    module Fleet
+      module Actions
+        # Multi Search API where the search will only be executed after specified checkpoints are available due to a refresh. This API is designed for internal use by the fleet server project.
+        # 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 [String] :index The index name to use as the default
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The request definitions (metadata-fleet search request definition pairs), separated by newlines (*Required*)
+        #
+        # @see [TODO]
+        #
+        def msearch(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'fleet.msearch' }
+
+          defined_params = [:index].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body   = arguments.delete(:body)
+
+          _index = arguments.delete(:index)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = if _index
+                     "#{Utils.__listify(_index)}/_fleet/_fleet_msearch"
+                   else
+                     '_fleet/_fleet_msearch'
+                   end
+          params = {}
+
+          if body.is_a?(Array) && body.any? { |d| d.has_key? :search }
+            payload = body
+                      .each_with_object([]) do |item, sum|
+                        meta = item
+                        data = meta.delete(:search)
+
+                        sum << meta
+                        sum << data
+                      end
+                      .map { |item| Elasticsearch::API.serializer.dump(item) }
+            payload << '' unless payload.empty?
+            payload = payload.join("\n")
+          elsif 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
+          end
+
+          headers.merge!('Content-Type' => 'application/x-ndjson')
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, payload, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/fleet/post_secret.rb

@@ -0,0 +1,57 @@
+# 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.
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
+module Elasticsearch
+  module API
+    module Fleet
+      module Actions
+        # Creates a secret stored by Fleet.
+        # 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 [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The secret value to store (*Required*)
+        #
+        # @see [TODO]
+        #
+        def post_secret(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'fleet.post_secret' }
+
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body   = arguments.delete(:body)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = '_fleet/secret'
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/fleet/search.rb

@@ -0,0 +1,73 @@
+# 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.
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
+module Elasticsearch
+  module API
+    module Fleet
+      module Actions
+        # Search API where the search will only be executed after specified checkpoints are available due to a refresh. This API is designed for internal use by the fleet server project.
+        # 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 [String] :index The index name to search.
+        # @option arguments [List] :wait_for_checkpoints Comma separated list of checkpoints, one per shard
+        # @option arguments [Time] :wait_for_checkpoints_timeout Explicit wait_for_checkpoints timeout
+        # @option arguments [Boolean] :allow_partial_search_results Indicate if an error should be returned if there is a partial search failure or timeout
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The search definition using the Query DSL
+        #
+        # @see [TODO]
+        #
+        def search(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'fleet.search' }
+
+          defined_params = [:index].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          _index = arguments.delete(:index)
+
+          method = if body
+                     Elasticsearch::API::HTTP_POST
+                   else
+                     Elasticsearch::API::HTTP_GET
+                   end
+
+          path = "#{Utils.__listify(_index)}/_fleet/_fleet_search"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -14,7 +14,10 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
 module Elasticsearch
   module API
     module Actions
@@ -22,7 +25,7 @@ module Elasticsearch
       #
       # @option arguments [String] :id The document ID
       # @option arguments [String] :index The name of the index
-      # @option arguments [String] :type The type of the document (use `_all` to fetch the first document matching the ID across all types) *Deprecated*
+      # @option arguments [Boolean] :force_synthetic_source Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index.
       # @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
@@ -32,61 +35,47 @@ 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 [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
       #
-      # *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.13/docs-get.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.14/docs-get.html
       #
       def get(arguments = {})
+        request_opts = { endpoint: arguments[:endpoint] || 'get' }
+
+        defined_params = %i[index id].each_with_object({}) do |variable, set_variables|
+          set_variables[variable] = arguments[variable] if arguments.key?(variable)
+        end
+        request_opts[:defined_params] = defined_params unless defined_params.empty?
+
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
         raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
 
+        arguments = arguments.clone
         headers = arguments.delete(:headers) || {}
 
-        arguments = arguments.clone
+        body = nil
 
         _id = arguments.delete(:id)
 
         _index = arguments.delete(:index)
 
-        _type = arguments.delete(:type)
-
         method = Elasticsearch::API::HTTP_GET
-        path   = if _index && _type && _id
-                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/#{Utils.__listify(_id)}"
-                 else
-                   "#{Utils.__listify(_index)}/_doc/#{Utils.__listify(_id)}"
-                 end
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+        path   = "#{Utils.__listify(_index)}/_doc/#{Utils.__listify(_id)}"
+        params = Utils.process_params(arguments)
 
-        body = nil
         if Array(arguments[:ignore]).include?(404)
-          Utils.__rescue_from_not_found { perform_request(method, path, params, body, headers).body }
+          Utils.__rescue_from_not_found do
+            Elasticsearch::API::Response.new(
+              perform_request(method, path, params, body, headers, request_opts)
+            )
+          end
         else
-          perform_request(method, path, params, body, headers).body
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
         end
       end
-
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.2.0
-      ParamsRegistry.register(:get, [
-        :stored_fields,
-        :preference,
-        :realtime,
-        :refresh,
-        :routing,
-        :_source,
-        :_source_excludes,
-        :_source_includes,
-        :version,
-        :version_type
-      ].freeze)
     end
   end
 end

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

@@ -14,7 +14,10 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
 module Elasticsearch
   module API
     module Actions
@@ -24,31 +27,33 @@ module Elasticsearch
       # @option arguments [Time] :master_timeout Specify timeout for connection to master
       # @option arguments [Hash] :headers Custom HTTP headers
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/modules-scripting.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.14/modules-scripting.html
       #
       def get_script(arguments = {})
+        request_opts = { endpoint: arguments[:endpoint] || 'get_script' }
+
+        defined_params = [:id].each_with_object({}) do |variable, set_variables|
+          set_variables[variable] = arguments[variable] if arguments.key?(variable)
+        end
+        request_opts[:defined_params] = defined_params unless defined_params.empty?
+
         raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
 
+        arguments = arguments.clone
         headers = arguments.delete(:headers) || {}
 
-        arguments = arguments.clone
+        body = nil
 
         _id = arguments.delete(:id)
 
         method = Elasticsearch::API::HTTP_GET
         path   = "_scripts/#{Utils.__listify(_id)}"
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+        params = Utils.process_params(arguments)
 
-        body = nil
-        perform_request(method, path, params, body, headers).body
+        Elasticsearch::API::Response.new(
+          perform_request(method, path, params, body, headers, request_opts)
+        )
       end
-
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.2.0
-      ParamsRegistry.register(:get_script, [
-        :master_timeout
-      ].freeze)
     end
   end
 end

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

@@ -14,31 +14,34 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
 module Elasticsearch
   module API
     module Actions
       # Returns all script contexts.
-      # 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 [Hash] :headers Custom HTTP headers
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/painless/7.13/painless-contexts.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/painless/8.14/painless-contexts.html
       #
       def get_script_context(arguments = {})
-        headers = arguments.delete(:headers) || {}
+        request_opts = { endpoint: arguments[:endpoint] || 'get_script_context' }
 
         arguments = arguments.clone
+        headers = arguments.delete(:headers) || {}
+
+        body   = nil
 
         method = Elasticsearch::API::HTTP_GET
-        path   = "_script_context"
+        path   = '_script_context'
         params = {}
 
-        body = nil
-        perform_request(method, path, params, body, headers).body
+        Elasticsearch::API::Response.new(
+          perform_request(method, path, params, body, headers, request_opts)
+        )
       end
     end
   end

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

@@ -14,31 +14,34 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
 module Elasticsearch
   module API
     module Actions
       # Returns available script types, languages and contexts
-      # 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 [Hash] :headers Custom HTTP headers
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/modules-scripting.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.14/modules-scripting.html
       #
       def get_script_languages(arguments = {})
-        headers = arguments.delete(:headers) || {}
+        request_opts = { endpoint: arguments[:endpoint] || 'get_script_languages' }
 
         arguments = arguments.clone
+        headers = arguments.delete(:headers) || {}
+
+        body   = nil
 
         method = Elasticsearch::API::HTTP_GET
-        path   = "_script_language"
+        path   = '_script_language'
         params = {}
 
-        body = nil
-        perform_request(method, path, params, body, headers).body
+        Elasticsearch::API::Response.new(
+          perform_request(method, path, params, body, headers, request_opts)
+        )
       end
     end
   end

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

@@ -14,7 +14,10 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
 module Elasticsearch
   module API
     module Actions
@@ -22,7 +25,6 @@ module Elasticsearch
       #
       # @option arguments [String] :id The document ID
       # @option arguments [String] :index The name of the index
-      # @option arguments [String] :type The type of the document; deprecated and optional starting with 7.0 *Deprecated*
       # @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
       # @option arguments [Boolean] :refresh Refresh the shard containing the document before performing the operation
@@ -31,56 +33,39 @@ 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 [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
       #
-      # *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.13/docs-get.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.14/docs-get.html
       #
       def get_source(arguments = {})
+        request_opts = { endpoint: arguments[:endpoint] || 'get_source' }
+
+        defined_params = %i[index id].each_with_object({}) do |variable, set_variables|
+          set_variables[variable] = arguments[variable] if arguments.key?(variable)
+        end
+        request_opts[:defined_params] = defined_params unless defined_params.empty?
+
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
         raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
 
+        arguments = arguments.clone
         headers = arguments.delete(:headers) || {}
 
-        arguments = arguments.clone
+        body = nil
 
         _id = arguments.delete(:id)
 
         _index = arguments.delete(:index)
 
-        _type = arguments.delete(:type)
-
         method = Elasticsearch::API::HTTP_GET
-        path   = if _index && _type && _id
-                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/#{Utils.__listify(_id)}/_source"
-                 else
-                   "#{Utils.__listify(_index)}/_source/#{Utils.__listify(_id)}"
-                 end
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+        path   = "#{Utils.__listify(_index)}/_source/#{Utils.__listify(_id)}"
+        params = Utils.process_params(arguments)
 
-        body = nil
-        perform_request(method, path, params, body, headers).body
+        Elasticsearch::API::Response.new(
+          perform_request(method, path, params, body, headers, request_opts)
+        )
       end
-
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.2.0
-      ParamsRegistry.register(:get_source, [
-        :preference,
-        :realtime,
-        :refresh,
-        :routing,
-        :_source,
-        :_source_excludes,
-        :_source_includes,
-        :version,
-        :version_type
-      ].freeze)
     end
   end
 end

data/lib/elasticsearch/api/actions/graph/explore.rb

@@ -0,0 +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.
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
+module Elasticsearch
+  module API
+    module Graph
+      module Actions
+        # Explore extracted and summarized information about the documents and terms in an index.
+        #
+        # @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 [String] :routing Specific routing value
+        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body Graph Query DSL
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.14/graph-explore-api.html
+        #
+        def explore(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'graph.explore' }
+
+          defined_params = [:index].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          _index = arguments.delete(:index)
+
+          method = if body
+                     Elasticsearch::API::HTTP_POST
+                   else
+                     Elasticsearch::API::HTTP_GET
+                   end
+
+          path = "#{Utils.__listify(_index)}/_graph/explore"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end