elasticsearch-api 7.6.0 → 7.7.0.pre

data/lib/elasticsearch/api/actions/cluster/put_component_template.rb

@@ -0,0 +1,49 @@
+# Licensed to Elasticsearch B.V under one or more agreements.
+# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+# See the LICENSE file in the project root for more information
+
+module Elasticsearch
+  module API
+    module Cluster
+      module Actions
+        # Creates or updates a component template
+        #
+        # @option arguments [String] :name The name of the template
+        # @option arguments [Boolean] :create Whether the index template should only be added if new or can also replace an existing one
+        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [Time] :master_timeout Specify timeout for connection to master
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The template definition (*Required*)
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-templates.html
+        #
+        def put_component_template(arguments = {})
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+          raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
+
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _name = arguments.delete(:name)
+
+          method = Elasticsearch::API::HTTP_PUT
+          path   = "_component_template/#{Utils.__listify(_name)}"
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+
+          body = arguments[:body]
+          perform_request(method, path, params, body, headers).body
+        end
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.2.0
+        ParamsRegistry.register(:put_component_template, [
+          :create,
+          :timeout,
+          :master_timeout
+        ].freeze)
+end
+      end
+  end
+end

data/lib/elasticsearch/api/actions/cluster/put_settings.rb

@@ -11,14 +11,16 @@ module Elasticsearch
         # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
         # @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 settings to be updated. Can be either `transient` or `persistent` (survives cluster restart). (*Required*)
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/cluster-update-settings.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html
         #
         def put_settings(arguments = {})
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
 
+          headers = arguments.delete(:headers) || {}
+
           arguments = arguments.clone
 
           method = Elasticsearch::API::HTTP_PUT
@@ -26,7 +28,7 @@ module Elasticsearch
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = arguments[:body] || {}
-          perform_request(method, path, params, body).body
+          perform_request(method, path, params, body, headers).body
         end
 
         # Register this action with its valid params when the module is loaded.

data/lib/elasticsearch/api/actions/cluster/remote_info.rb

@@ -8,11 +8,13 @@ module Elasticsearch
       module Actions
         # Returns the information about configured remote clusters.
         #
-
+        # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/cluster-remote-info.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-remote-info.html
         #
         def remote_info(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
           arguments = arguments.clone
 
           method = Elasticsearch::API::HTTP_GET
@@ -20,7 +22,7 @@ module Elasticsearch
           params = {}
 
           body = nil
-          perform_request(method, path, params, body).body
+          perform_request(method, path, params, body, headers).body
         end
 end
       end

data/lib/elasticsearch/api/actions/cluster/reroute.rb

@@ -16,12 +16,14 @@ module Elasticsearch
 
         # @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 definition of `commands` to perform (`move`, `cancel`, `allocate`)
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/cluster-reroute.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-reroute.html
         #
         def reroute(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
           arguments = arguments.clone
 
           method = Elasticsearch::API::HTTP_POST
@@ -29,7 +31,7 @@ module Elasticsearch
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = arguments[:body] || {}
-          perform_request(method, path, params, body).body
+          perform_request(method, path, params, body, headers).body
         end
 
         # Register this action with its valid params when the module is loaded.

data/lib/elasticsearch/api/actions/cluster/state.rb

@@ -20,12 +20,15 @@ module Elasticsearch
         # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
         # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
         # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
-        #   (options: open,closed,none,all)
+        #   (options: open,closed,hidden,none,all)
 
+        # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/cluster-state.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-state.html
         #
         def state(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
           arguments = arguments.clone
 
           _metric = arguments.delete(:metric)
@@ -39,11 +42,11 @@ module Elasticsearch
                      "_cluster/state/#{Utils.__listify(_metric)}"
                    else
                      "_cluster/state"
-end
+      end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = nil
-          perform_request(method, path, params, body).body
+          perform_request(method, path, params, body, headers).body
         end
 
         # Register this action with its valid params when the module is loaded.

data/lib/elasticsearch/api/actions/cluster/stats.rb

@@ -11,11 +11,13 @@ module Elasticsearch
         # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
         # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
         # @option arguments [Time] :timeout Explicit operation timeout
-
+        # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/cluster-stats.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-stats.html
         #
         def stats(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
           arguments = arguments.clone
 
           _node_id = arguments.delete(:node_id)
@@ -25,11 +27,11 @@ module Elasticsearch
                      "_cluster/stats/nodes/#{Utils.__listify(_node_id)}"
                    else
                      "_cluster/stats"
-end
+      end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = nil
-          perform_request(method, path, params, body).body
+          perform_request(method, path, params, body, headers).body
         end
 
         # Register this action with its valid params when the module is loaded.

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

@@ -13,7 +13,7 @@ module Elasticsearch
       # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled
       # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
       # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
-      #   (options: open,closed,none,all)
+      #   (options: open,closed,hidden,none,all)
 
       # @option arguments [Number] :min_score Include only documents with a specific `_score` value in the result
       # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
@@ -27,7 +27,7 @@ module Elasticsearch
       # @option arguments [String] :df The field to use as default where no field prefix is given in the query string
       # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
       # @option arguments [Number] :terminate_after The maximum count for each shard, upon reaching which the query execution will terminate early
-
+      # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body A query to restrict the results specified with the Query DSL (optional)
       #
       # *Deprecation notice*:
@@ -35,9 +35,11 @@ module Elasticsearch
       # Deprecated since version 7.0.0
       #
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/search-count.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html
       #
       def count(arguments = {})
+        headers = arguments.delete(:headers) || {}
+
         arguments = arguments.clone
 
         _index = arguments.delete(:index)
@@ -48,7 +50,7 @@ module Elasticsearch
                    Elasticsearch::API::HTTP_POST
                  else
                    Elasticsearch::API::HTTP_GET
-end
+    end
 
         path = if _index && _type
                  "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_count"
@@ -56,11 +58,11 @@ end
                  "#{Utils.__listify(_index)}/_count"
                else
                  "_count"
-end
+    end
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
         body = arguments[:body]
-        perform_request(method, path, params, body).body
+        perform_request(method, path, params, body, headers).body
       end
 
       # Register this action with its valid params when the module is loaded.

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

@@ -23,7 +23,7 @@ module Elasticsearch
       #   (options: internal,external,external_gte)
 
       # @option arguments [String] :pipeline The pipeline id to preprocess incoming documents with
-
+      # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body The document (*Required*)
       #
       # *Deprecation notice*:
@@ -31,7 +31,7 @@ module Elasticsearch
       # Deprecated since version 7.0.0
       #
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/docs-index_.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html
       #
       def create(arguments = {})
         if arguments[:id]

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

@@ -22,18 +22,21 @@ module Elasticsearch
       # @option arguments [String] :version_type Specific version type
       #   (options: internal,external,external_gte,force)
 
+      # @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.5/docs-delete.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html
       #
       def delete(arguments = {})
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
         raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
 
+        headers = arguments.delete(:headers) || {}
+
         arguments = arguments.clone
 
         _id = arguments.delete(:id)
@@ -52,9 +55,9 @@ module Elasticsearch
 
         body = nil
         if Array(arguments[:ignore]).include?(404)
-          Utils.__rescue_from_not_found { perform_request(method, path, params, body).body }
+          Utils.__rescue_from_not_found { perform_request(method, path, params, body, headers).body }
         else
-          perform_request(method, path, params, body).body
+          perform_request(method, path, params, body, headers).body
         end
       end
 

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

@@ -22,7 +22,7 @@ module Elasticsearch
       #   (options: abort,proceed)
 
       # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
-      #   (options: open,closed,none,all)
+      #   (options: open,closed,hidden,none,all)
 
       # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
       # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
@@ -49,8 +49,8 @@ module Elasticsearch
       # @option arguments [Number] :scroll_size Size on the scroll request powering the delete by query
       # @option arguments [Boolean] :wait_for_completion Should the request should block until the delete by query is complete.
       # @option arguments [Number] :requests_per_second The throttle for this request in sub-requests per second. -1 means no throttle.
-      # @option arguments [Number] :slices The number of slices this task should be divided into. Defaults to 1 meaning the task isn't sliced into subtasks.
-
+      # @option arguments [Number|string] :slices The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`.
+      # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body The search definition using the Query DSL (*Required*)
       #
       # *Deprecation notice*:
@@ -58,12 +58,14 @@ module Elasticsearch
       # Deprecated since version 7.0.0
       #
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/docs-delete-by-query.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html
       #
       def delete_by_query(arguments = {})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
 
+        headers = arguments.delete(:headers) || {}
+
         arguments = arguments.clone
 
         _index = arguments.delete(:index)
@@ -79,7 +81,7 @@ module Elasticsearch
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
         body = arguments[:body]
-        perform_request(method, path, params, body).body
+        perform_request(method, path, params, body, headers).body
       end
 
       # Register this action with its valid params when the module is loaded.

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

@@ -9,13 +9,15 @@ module Elasticsearch
       #
       # @option arguments [String] :task_id The task id to rethrottle
       # @option arguments [Number] :requests_per_second The throttle to set on this request in floating sub-requests per second. -1 means set no throttle.  (*Required*)
-
+      # @option arguments [Hash] :headers Custom HTTP headers
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/docs-delete-by-query.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html
       #
       def delete_by_query_rethrottle(arguments = {})
         raise ArgumentError, "Required argument 'task_id' missing" unless arguments[:task_id]
 
+        headers = arguments.delete(:headers) || {}
+
         arguments = arguments.clone
 
         _task_id = arguments.delete(:task_id)
@@ -25,7 +27,7 @@ module Elasticsearch
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
         body = nil
-        perform_request(method, path, params, body).body
+        perform_request(method, path, params, body, headers).body
       end
 
       # Register this action with its valid params when the module is loaded.

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

@@ -10,13 +10,15 @@ module Elasticsearch
       # @option arguments [String] :id Script ID
       # @option arguments [Time] :timeout Explicit operation timeout
       # @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.5/modules-scripting.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html
       #
       def delete_script(arguments = {})
         raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
 
+        headers = arguments.delete(:headers) || {}
+
         arguments = arguments.clone
 
         _id = arguments.delete(:id)
@@ -26,7 +28,7 @@ module Elasticsearch
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
         body = nil
-        perform_request(method, path, params, body).body
+        perform_request(method, path, params, body, headers).body
       end
 
       # Register this action with its valid params when the module is loaded.

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

@@ -22,18 +22,21 @@ module Elasticsearch
       # @option arguments [String] :version_type Specific version type
       #   (options: internal,external,external_gte,force)
 
+      # @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.5/docs-get.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html
       #
       def exists(arguments = {})
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
         raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
 
+        headers = arguments.delete(:headers) || {}
+
         arguments = arguments.clone
 
         _id = arguments.delete(:id)
@@ -53,7 +56,7 @@ module Elasticsearch
         body = nil
 
         Utils.__rescue_from_not_found do
-          perform_request(method, path, params, body).status == 200 ? true : false
+          perform_request(method, path, params, body, headers).status == 200 ? true : false
         end
       end
 

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

@@ -21,18 +21,21 @@ module Elasticsearch
       # @option arguments [String] :version_type Specific version type
       #   (options: internal,external,external_gte,force)
 
+      # @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.5/docs-get.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html
       #
       def exists_source(arguments = {})
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
         raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
 
+        headers = arguments.delete(:headers) || {}
+
         arguments = arguments.clone
 
         _id = arguments.delete(:id)
@@ -50,7 +53,7 @@ module Elasticsearch
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
         body = nil
-        perform_request(method, path, params, body).body
+        perform_request(method, path, params, body, headers).body
       end
 
       alias_method :exists_source?, :exists_source