elasticsearch-api 7.17.11 → 9.0.2

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

@@ -14,79 +14,124 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Actions
-      # Returns a document.
+      # Get a document by its ID.
+      # Get a document and its source or stored fields from an index.
+      # By default, this API is realtime and is not affected by the refresh rate of the index (when data will become visible for search).
+      # In the case where stored fields are requested with the +stored_fields+ parameter and the document has been updated but is not yet refreshed, the API will have to parse and analyze the source to extract the stored fields.
+      # To turn off realtime behavior, set the +realtime+ parameter to false.
+      # **Source filtering**
+      # By default, the API returns the contents of the +_source+ field unless you have used the +stored_fields+ parameter or the +_source+ field is turned off.
+      # You can turn off +_source+ retrieval by using the +_source+ parameter:
+      # +
+      # GET my-index-000001/_doc/0?_source=false
+      # +
+      # If you only need one or two fields from the +_source+, use the +_source_includes+ or +_source_excludes+ parameters to include or filter out particular fields.
+      # This can be helpful with large documents where partial retrieval can save on network overhead
+      # Both parameters take a comma separated list of fields or wildcard expressions.
+      # For example:
+      # +
+      # GET my-index-000001/_doc/0?_source_includes=*.id&_source_excludes=entities
+      # +
+      # If you only want to specify includes, you can use a shorter notation:
+      # +
+      # GET my-index-000001/_doc/0?_source=*.id
+      # +
+      # **Routing**
+      # If routing is used during indexing, the routing value also needs to be specified to retrieve a document.
+      # For example:
+      # +
+      # GET my-index-000001/_doc/2?routing=user1
+      # +
+      # This request gets the document with ID 2, but it is routed based on the user.
+      # The document is not fetched if the correct routing is not specified.
+      # **Distributed**
+      # The GET operation is hashed into a specific shard ID.
+      # It is then redirected to one of the replicas within that shard ID and returns the result.
+      # The replicas are the primary shard and its replicas within that shard ID group.
+      # This means that the more replicas you have, the better your GET scaling will be.
+      # **Versioning support**
+      # You can use the +version+ parameter to retrieve the document only if its current version is equal to the specified one.
+      # Internally, Elasticsearch has marked the old document as deleted and added an entirely new document.
+      # The old version of the document doesn't disappear immediately, although you won't be able to access it.
+      # Elasticsearch cleans up deleted documents in the background as you continue to index more data.
       #
-      # @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 [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
-      # @option arguments [Boolean] :refresh Refresh the shard containing the document before performing the operation
-      # @option arguments [String] :routing Specific routing value
-      # @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 [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] :id A unique document identifier. (*Required*)
+      # @option arguments [String] :index The name of the index that contains the document. (*Required*)
+      # @option arguments [Boolean] :force_synthetic_source Indicates whether the request forces synthetic +_source+.
+      #  Use this paramater to test if the mapping supports synthetic +_source+ and to get a sense of the worst case performance.
+      #  Fetches with this parameter enabled will be slower than enabling synthetic source natively in the index.
+      # @option arguments [String] :preference The node or shard the operation should be performed on.
+      #  By default, the operation is randomized between the shard replicas.If it is set to +_local+, the operation will prefer to be run on a local allocated shard when possible.
+      #  If it is set to a custom value, the value is used to guarantee that the same shards will be used for the same custom value.
+      #  This can help with "jumping values" when hitting different shards in different refresh states.
+      #  A sample value can be something like the web session ID or the user name.
+      # @option arguments [Boolean] :realtime If +true+, the request is real-time as opposed to near-real-time. Server default: true.
+      # @option arguments [Boolean] :refresh If +true+, the request refreshes the relevant shards before retrieving the document.
+      #  Setting it to +true+ should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).
+      # @option arguments [String] :routing A custom value used to route operations to a specific shard.
+      # @option arguments [Boolean, String, Array<String>] :_source Indicates whether to return the +_source+ field (+true+ or +false+) or lists the fields to return.
+      # @option arguments [String, Array<String>] :_source_excludes A comma-separated list of source fields to exclude from the response.
+      #  You can also use this parameter to exclude fields from the subset specified in +_source_includes+ query parameter.
+      #  If the +_source+ parameter is +false+, this parameter is ignored.
+      # @option arguments [String, Array<String>] :_source_includes A comma-separated list of source fields to include in the response.
+      #  If this parameter is specified, only these source fields are returned.
+      #  You can exclude fields from this subset using the +_source_excludes+ query parameter.
+      #  If the +_source+ parameter is +false+, this parameter is ignored.
+      # @option arguments [String, Array<String>] :stored_fields A comma-separated list of stored fields to return as part of a hit.
+      #  If no fields are specified, no stored fields are included in the response.
+      #  If this field is specified, the +_source+ parameter defaults to +false+.
+      #  Only leaf fields can be retrieved with the +stored_field+ option.
+      #  Object fields can't be returned;​if specified, the request fails.
+      # @option arguments [Integer] :version The version number for concurrency control.
+      #  It must match the current version of the document for the request to succeed.
+      # @option arguments [String] :version_type The version type.
       # @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.17/docs-get.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-get
       #
       def get(arguments = {})
+        request_opts = { endpoint: arguments[:endpoint] || 'get' }
+
+        defined_params = [: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,41 +14,49 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Actions
-      # Returns a script.
+      # Get a script or search template.
+      # Retrieves a stored script or search template.
       #
-      # @option arguments [String] :id Script ID
-      # @option arguments [Time] :master_timeout Specify timeout for connection to master
+      # @option arguments [String] :id The identifier for the stored script or search template. (*Required*)
+      # @option arguments [Time] :master_timeout The period to wait for the master node.
+      #  If the master node is not available before the timeout expires, the request fails and returns an error.
+      #  It can also be set to +-1+ to indicate that the request should never timeout. Server default: .
       # @option arguments [Hash] :headers Custom HTTP headers
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/modules-scripting.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-get-script
       #
       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__)
+        path   = "_scripts/#{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_script, [
-        :master_timeout
-      ].freeze)
     end
   end
 end

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

@@ -14,27 +14,35 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Actions
-      # Returns all script contexts.
+      # Get script contexts.
+      # Get a list of supported script contexts and their methods.
       #
       # @option arguments [Hash] :headers Custom HTTP headers
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/painless/7.17/painless-contexts.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-get-script-context
       #
       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,27 +14,35 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Actions
-      # Returns available script types, languages and contexts
+      # Get script languages.
+      # Get a list of available script types, languages, and contexts.
       #
       # @option arguments [Hash] :headers Custom HTTP headers
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/modules-scripting.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-get-script-languages
       #
       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,73 +14,71 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Actions
-      # Returns the source of a document.
+      # Get a document's source.
+      # Get the source of a document.
+      # For example:
+      # +
+      # GET my-index-000001/_source/1
+      # +
+      # You can use the source filtering parameters to control which parts of the +_source+ are returned:
+      # +
+      # GET my-index-000001/_source/1/?_source_includes=*.id&_source_excludes=entities
+      # +
       #
-      # @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
-      # @option arguments [String] :routing Specific routing value
-      # @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 [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] :id A unique document identifier. (*Required*)
+      # @option arguments [String] :index The name of the index that contains the document. (*Required*)
+      # @option arguments [String] :preference The node or shard the operation should be performed on.
+      #  By default, the operation is randomized between the shard replicas.
+      # @option arguments [Boolean] :realtime If +true+, the request is real-time as opposed to near-real-time. Server default: true.
+      # @option arguments [Boolean] :refresh If +true+, the request refreshes the relevant shards before retrieving the document.
+      #  Setting it to +true+ should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).
+      # @option arguments [String] :routing A custom value used to route operations to a specific shard.
+      # @option arguments [Boolean, String, Array<String>] :_source Indicates whether to return the +_source+ field (+true+ or +false+) or lists the fields to return.
+      # @option arguments [String, Array<String>] :_source_excludes A comma-separated list of source fields to exclude in the response.
+      # @option arguments [String, Array<String>] :_source_includes A comma-separated list of source fields to include in the response.
+      # @option arguments [String, Array<String>] :stored_fields A comma-separated list of stored fields to return as part of a hit.
+      # @option arguments [Integer] :version The version number for concurrency control.
+      #  It must match the current version of the document for the request to succeed.
+      # @option arguments [String] :version_type The version type.
       # @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.17/docs-get.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-get
       #
       def get_source(arguments = {})
+        request_opts = { endpoint: arguments[:endpoint] || 'get_source' }
+
+        defined_params = [: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,75 @@
+# 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.
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
+module Elasticsearch
+  module API
+    module Graph
+      module Actions
+        # Explore graph analytics.
+        # Extract and summarize information about the documents and terms in an Elasticsearch data stream or index.
+        # The easiest way to understand the behavior of this API is to use the Graph UI to explore connections.
+        # An initial request to the +_explore+ API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph.
+        # Subsequent requests enable you to spider out from one more vertices of interest.
+        # You can exclude vertices that have already been returned.
+        #
+        # @option arguments [String, Array] :index Name of the index. (*Required*)
+        # @option arguments [String] :routing Custom value used to route operations to a specific shard.
+        # @option arguments [Time] :timeout Specifies the period of time to wait for a response from each shard.
+        #  If no response is received before the timeout expires, the request fails and returns an error.
+        #  Defaults to no timeout.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body request body
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-graph
+        #
+        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

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

@@ -0,0 +1,75 @@
+# 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.
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
+module Elasticsearch
+  module API
+    module Actions
+      # Get the cluster health.
+      # Get a report with the health status of an Elasticsearch cluster.
+      # The report contains a list of indicators that compose Elasticsearch functionality.
+      # Each indicator has a health status of: green, unknown, yellow or red.
+      # The indicator will provide an explanation and metadata describing the reason for its current health status.
+      # The cluster’s status is controlled by the worst indicator status.
+      # In the event that an indicator’s status is non-green, a list of impacts may be present in the indicator result which detail the functionalities that are negatively affected by the health issue.
+      # Each impact carries with it a severity level, an area of the system that is affected, and a simple description of the impact on the system.
+      # Some health indicators can determine the root cause of a health problem and prescribe a set of steps that can be performed in order to improve the health of the system.
+      # The root cause and remediation steps are encapsulated in a diagnosis.
+      # A diagnosis contains a cause detailing a root cause analysis, an action containing a brief description of the steps to take to fix the problem, the list of affected resources (if applicable), and a detailed step-by-step troubleshooting guide to fix the diagnosed problem.
+      # NOTE: The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently.
+      # When setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic.
+      #
+      # @option arguments [String] :feature A feature of the cluster, as returned by the top-level health report API.
+      # @option arguments [Time] :timeout Explicit operation timeout.
+      # @option arguments [Boolean] :verbose Opt-in for more information about the health of the system. Server default: true.
+      # @option arguments [Integer] :size Limit the number of affected resources the health report API returns. Server default: 1000.
+      # @option arguments [Hash] :headers Custom HTTP headers
+      #
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-health-report
+      #
+      def health_report(arguments = {})
+        request_opts = { endpoint: arguments[:endpoint] || 'health_report' }
+
+        defined_params = [:feature].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?
+
+        arguments = arguments.clone
+        headers = arguments.delete(:headers) || {}
+
+        body = nil
+
+        _feature = arguments.delete(:feature)
+
+        method = Elasticsearch::API::HTTP_GET
+        path   = if _feature
+                   "_health_report/#{Utils.listify(_feature)}"
+                 else
+                   '_health_report'
+                 end
+        params = Utils.process_params(arguments)
+
+        Elasticsearch::API::Response.new(
+          perform_request(method, path, params, body, headers, request_opts)
+        )
+      end
+    end
+  end
+end