elasticsearch-api 6.2.0 → 6.3.0

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

@@ -13,25 +13,17 @@ module Elasticsearch
         #
         #     client.cluster.health wait_for_status: 'yellow'
         #
-        # @option arguments [String] :index Limit the information returned to a specific index
-        # @option arguments [String] :level Specify the level of detail for returned information
-        #                                   (options: cluster, indices, shards)
-        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
-        #                                    (default: false)
+        # @option arguments [List] :index Limit the information returned to a specific index
+        # @option arguments [String] :level Specify the level of detail for returned information (options: cluster, indices, shards)
+        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         # @option arguments [Time] :timeout Explicit operation timeout
-        # @option arguments [Number] :wait_for_active_shards Wait until the specified number of shards is active
-        # @option arguments [Number] :wait_for_nodes Wait until the specified number of nodes is available
-        # @option arguments [Number] :wait_for_relocating_shards Wait until the specified number of relocating
-        #                                                        shards is finished
-        # @option arguments [Boolean] :wait_for_no_relocating_shards Whether to wait until there are no relocating
-        #                                                            shards in the cluster
-        # @option arguments [Boolean] :wait_for_no_initializing_shards Whether to wait until there are no
-        #                                                              initializing shards in the cluster
-        # @option arguments [String] :wait_for_status Wait until cluster is in a specific state
-        #                                             (options: green, yellow, red)
-        # @option arguments [List] :wait_for_events Wait until all currently queued events with the given priorty
-        #                                           are processed (immediate, urgent, high, normal, low, languid)
+        # @option arguments [String] :wait_for_active_shards Wait until the specified number of shards is active
+        # @option arguments [String] :wait_for_nodes Wait until the specified number of nodes is available
+        # @option arguments [String] :wait_for_events Wait until all currently queued events with the given priority are processed (options: immediate, urgent, high, normal, low, languid)
+        # @option arguments [Boolean] :wait_for_no_relocating_shards Whether to wait until there are no relocating shards in the cluster
+        # @option arguments [Boolean] :wait_for_no_initializing_shards Whether to wait until there are no initializing shards in the cluster
+        # @option arguments [String] :wait_for_status Wait until cluster is in a specific state (options: green, yellow, red)
         #
         # @see http://elasticsearch.org/guide/reference/api/admin-cluster-health/
         #
@@ -57,11 +49,10 @@ module Elasticsearch
             :timeout,
             :wait_for_active_shards,
             :wait_for_nodes,
-            :wait_for_relocating_shards,
+            :wait_for_events,
             :wait_for_no_relocating_shards,
             :wait_for_no_initializing_shards,
-            :wait_for_status,
-            :wait_for_events ].freeze)
+            :wait_for_status ].freeze)
       end
     end
   end

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

@@ -10,11 +10,10 @@ module Elasticsearch
         #
         #     client.cluster.pending_tasks
         #
-        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
-        #                                    (default: false)
+        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
         # @option arguments [Time] :master_timeout Specify timeout for connection to master
         #
-        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cluster-pending.html
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-pending.html
         #
         def pending_tasks(arguments={})
           method = HTTP_GET

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

@@ -9,8 +9,10 @@ module Elasticsearch
         #
         #     client.cluster.put_settings body: { transient: { 'cluster.routing.allocation.disable_allocation' => true } }
         #
-        # @option arguments [Hash] :body The settings to be updated. Can be either `transient` or `persistent`
-        #                                (survives cluster restart).
+        # @option arguments [Hash] :body The settings to be updated. Can be either `transient` or `persistent` (survives cluster restart). (*Required*)
+        # @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
         #
         # @see http://elasticsearch.org/guide/reference/api/admin-cluster-update-settings/
         #
@@ -26,7 +28,10 @@ module Elasticsearch
         # Register this action with its valid params when the module is loaded.
         #
         # @since 6.2.0
-        ParamsRegistry.register(:put_settings, [ :flat_settings ].freeze)
+        ParamsRegistry.register(:put_settings, [
+            :flat_settings,
+            :master_timeout,
+            :timeout ].freeze)
       end
     end
   end

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

@@ -6,7 +6,7 @@ module Elasticsearch
         # Returns the configured remote cluster information
         #
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-remote-info.html
+        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-remote-info.html
         #
         def remote_info(arguments={})
           method = Elasticsearch::API::HTTP_GET
@@ -16,6 +16,12 @@ module Elasticsearch
 
           perform_request(method, path, params, body).body
         end
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.2.0
+        ParamsRegistry.register(:remote_info, [
+        ].freeze)
       end
     end
   end

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

@@ -21,13 +21,13 @@ module Elasticsearch
         #
         # @option arguments [Hash] :body The definition of `commands` to perform (`move`, `cancel`, `allocate`)
         # @option arguments [Boolean] :dry_run Simulate the operation only and return the resulting state
-        # @option arguments [Boolean] :explain Return an explanation for why the commands can or cannot be executed
-        # @option arguments [Boolean] :metric Limit the information returned to the specified metrics.
-        #                                     Defaults to all but metadata. (Options: _all, blocks, metadata,
-        #                                     nodes, routing_table, master_node, version)
-        # @option arguments [Time] :master_timeout Specify timeout for connection to master
+        # @option arguments [Boolean] :explain Return an explanation of why the commands can or cannot be executed
         # @option arguments [Boolean] :retry_failed Retries allocation of shards that are blocked due to too many
-        #                                           subsequent allocation failures
+        #   subsequent allocation failures
+        # @option arguments [List] :metric Limit the information returned to the specified metrics. Defaults to all
+        #   but metadata (options: _all, blocks, metadata, nodes, routing_table, master_node, version)
+        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @option arguments [Time] :timeout Explicit operation timeout
         #
         # @see http://elasticsearch.org/guide/reference/api/admin-cluster-reroute/
         #
@@ -47,9 +47,9 @@ module Elasticsearch
         ParamsRegistry.register(:reroute, [
             :dry_run,
             :explain,
+            :retry_failed,
             :metric,
             :master_timeout,
-            :retry_failed,
             :timeout ].freeze)
       end
     end

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

@@ -9,21 +9,24 @@ module Elasticsearch
         #
         #     client.cluster.state
         #
-        # @option arguments [List] :index A comma-separated list of index names; use `_all` or omit to
-        #                                 perform the operation on all indices
+        # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform
+        #   the operation on all indices
         # @option arguments [List] :metric Limit the information returned to the specified metrics
-        #                                 (options: _all, blocks, index_templates, metadata, nodes, routing_table,
-        #                                  master_node, version)
-        # @option arguments [List] :index_templates A comma separated list to return specific index templates when
-        #                                           returning metadata
+        #   (options: _all,blocks,metadata,nodes,routing_table,routing_nodes,master_node,version)
         # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
-        #                                    (default: false)
+        #   (default: false)
         # @option arguments [Time] :master_timeout Specify timeout for connection to master
-        # @option arguments [String] :expand_wildcards Whether to expand wildcard expression for inidices
-        #                                              (options: open, 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 [Boolean] :flat_settings Return settings in flat format (default: false)
+        # @option arguments [Number] :wait_for_metadata_version Wait for the metadata version to be equal or greater
+        #   than the specified metadata version
+        # @option arguments [Time] :wait_for_timeout The maximum time to wait for wait_for_metadata_version before
+        #   timing out
         # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
-        #                                                 unavailable (missing, closed, etc)
+        #   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)
         #
         # @see http://elasticsearch.org/guide/reference/api/admin-cluster-state/
         #
@@ -51,14 +54,14 @@ module Elasticsearch
         #
         # @since 6.2.0
         ParamsRegistry.register(:state, [
-            :metric,
-            :index_templates,
             :local,
             :master_timeout,
             :flat_settings,
+            :wait_for_metadata_version,
+            :wait_for_timeout,
+            :ignore_unavailable,
             :allow_no_indices,
-            :expand_wildcards,
-            :ignore_unavailable ].freeze)
+            :expand_wildcards ].freeze)
       end
     end
   end

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

@@ -5,16 +5,24 @@ module Elasticsearch
 
         # Returns statistical information about the cluster
         #
-        # @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 [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 [Boolean] :human Whether to return time and byte values in human-readable format.
         # @option arguments [Time] :timeout Explicit operation timeout
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-stats.html
+        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-stats.html
         #
         def stats(arguments={})
           method = 'GET'
-          path   = "_cluster/stats"
+          node_id = arguments.delete(:node_id)
+
+          if node_id
+            path = Utils.__pathify("_cluster/stats/nodes", node_id)
+          else
+            path = "_cluster/stats"
+          end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           body   = nil
 
@@ -26,7 +34,6 @@ module Elasticsearch
         # @since 6.2.0
         ParamsRegistry.register(:stats, [
             :flat_settings,
-            :human,
             :timeout ].freeze)
       end
     end

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

@@ -19,31 +19,20 @@ module Elasticsearch
       # @option arguments [List] :index A comma-separated list of indices to restrict the results
       # @option arguments [List] :type A comma-separated list of types to restrict the results
       # @option arguments [Hash] :body A query to restrict the results specified with the Query DSL (optional)
-      # @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.
-      # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices
-      #                                              that are open, closed or both.
-      #                                              (options: open, closed, none, all)
+      # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
+      # @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)
       # @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)
-      # @option arguments [String] :routing Specific routing value
+      # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
+      # @option arguments [List] :routing A comma-separated list of specific routing values
       # @option arguments [String] :q Query in the Lucene query string syntax
       # @option arguments [String] :analyzer The analyzer to use for the query string
-      # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be
-      #                                               analyzed (default: false)
-      # @option arguments [String] :default_operator The default operator for query string query (AND or OR)
-      #                                              (options: AND, OR)
-      # @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 [Boolean] :lowercase_expanded_terms Specify whether query terms should be lowercased
-      #
-      # @option arguments [Boolean] :terminate_after Specify the maximum count for each shard, upon reaching
-      #                                              which the query execution will terminate early.
+      # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
+      # @option arguments [String] :default_operator The default operator for query string query (AND or OR) (options: AND, OR)
+      # @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
       #
       # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-count.html
       #
@@ -62,6 +51,7 @@ module Elasticsearch
       # @since 6.2.0
       ParamsRegistry.register(:count, [
           :ignore_unavailable,
+          :ignore_throttled,
           :allow_no_indices,
           :expand_wildcards,
           :min_score,
@@ -73,7 +63,6 @@ module Elasticsearch
           :default_operator,
           :df,
           :lenient,
-          :lowercase_expanded_terms,
           :terminate_after ].freeze)
     end
   end

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

@@ -46,7 +46,7 @@ module Elasticsearch
       # @option arguments [Number] :version Explicit version number for concurrency control
       # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte, force)
       #
-      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-percolate.html
+      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-percolate.html
       #
       def count_percolate(arguments={})
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

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

@@ -13,18 +13,25 @@ module Elasticsearch
       #     client.delete index: 'myindex', type: 'mytype', id: '1', routing: 'abc123'
       #
       # @option arguments [String] :id The document ID (*Required*)
-      # @option arguments [Number,List] :ignore The list of HTTP errors to ignore; only `404` supported at the moment
       # @option arguments [String] :index The name of the index (*Required*)
       # @option arguments [String] :type The type of the document (*Required*)
-      # @option arguments [String] :consistency Specific write consistency setting for the operation
-      #                                         (options: one, quorum, all)
+      # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before
+      #   proceeding with the delete operation. Defaults to 1, meaning the primary shard only. Set to `all` for all
+      #   shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for
+      #   the shard (number of replicas + 1)
       # @option arguments [String] :parent ID of parent document
-      # @option arguments [Boolean] :refresh Refresh the index after performing the operation
-      # @option arguments [String] :replication Specific replication type (options: sync, async)
+      # @option arguments [String] :refresh If `true` then refresh the effected shards to make this operation visible
+      #   to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false`
+      #   (the default) then do nothing with refreshes. (options: true, false, wait_for)
       # @option arguments [String] :routing Specific routing value
       # @option arguments [Time] :timeout Explicit operation timeout
+      # @option arguments [Number] :if_seq_no only perform the delete operation if the last operation that has changed
+      #   the document has the specified sequence number
+      # @option arguments [Number] :if_primary_term only perform the delete operation if the last operation that has
+      #   changed the document has the specified primary term
       # @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, force)
       #
       # @see http://elasticsearch.org/guide/reference/api/delete/
       #
@@ -52,12 +59,13 @@ module Elasticsearch
       #
       # @since 6.2.0
       ParamsRegistry.register(:delete, [
-          :consistency,
+          :wait_for_active_shards,
           :parent,
           :refresh,
-          :replication,
           :routing,
           :timeout,
+          :if_seq_no,
+          :if_primary_term,
           :version,
           :version_type ].freeze)
     end

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

@@ -25,7 +25,7 @@ module Elasticsearch
       # @option arguments [Number] :from Starting offset (default: 0)
       # @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] :conflicts What to do when the delete-by-query hits version conflicts? (options: abort, proceed)
+      # @option arguments [String] :conflicts What to do when the delete by query hits version conflicts? (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)
       # @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)
@@ -37,8 +37,8 @@ module Elasticsearch
       # @option arguments [Number] :size Number of hits to return (default: 10)
       # @option arguments [List] :sort A comma-separated list of <field>:<direction> pairs
       # @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_exclude A list of fields to exclude from the returned _source field
-      # @option arguments [List] :_source_include A list of fields to extract and return from the _source field
+      # @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] :terminate_after The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
       # @option arguments [List] :stats Specific 'tag' of the request for logging and statistical purposes
       # @option arguments [Boolean] :version Specify whether to return document version as part of a hit
@@ -46,12 +46,12 @@ module Elasticsearch
       # @option arguments [Boolean] :refresh Should the effected indexes be refreshed?
       # @option arguments [Time] :timeout Time each individual bulk request should wait for shards that are unavailable.
       # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the delete by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
-      # @option arguments [Number] :scroll_size Size on the scroll request powering the update_by_query
-      # @option arguments [Boolean] :wait_for_completion Should the request should block until the delete-by-query is complete.
+      # @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 [Integer] :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] :slices The number of slices this task should be divided into. Defaults to 1 meaning the task isn't sliced into subtasks.
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html
       #
       def delete_by_query(arguments={})
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -89,9 +89,7 @@ module Elasticsearch
           :size,
           :sort,
           :_source,
-          :_source_exclude,
           :_source_excludes,
-          :_source_include,
           :_source_includes,
           :terminate_after,
           :stats,

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

@@ -0,0 +1,29 @@
+module Elasticsearch
+  module API
+    module Actions
+
+      # The value of requests_per_second can be changed on a running delete by query using the _rethrottle API
+      #
+      # @option arguments [String] :task_id The task id to rethrottle (*Required*)      
+      # @option arguments [Number] :requests_per_second The throttle to set on this request in floating sub-requests per second. -1 means set no throttle.      
+      #
+      # @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]
+        method = Elasticsearch::API::HTTP_POST
+        path   = "_delete_by_query/#{arguments[:task_id]}/_rethrottle"
+        params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+        body   = nil
+
+        perform_request(method, path, params, body).body
+      end
+
+      # Register this action with its valid params when the module is loaded.
+      #
+      # @since 6.2.0
+      ParamsRegistry.register(:delete_by_query_rethrottle, [
+          :requests_per_second ].freeze)
+    end
+  end
+end

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

@@ -5,11 +5,10 @@ module Elasticsearch
       # Remove an indexed script from Elasticsearch
       #
       # @option arguments [String] :id Script ID (*Required*)
-      # @option arguments [String] :lang Script language
-      # @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 [Time] :timeout Explicit operation timeout
+      # @option arguments [Time] :master_timeout Specify timeout for connection to master
       #
-      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-scripting.html
+      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-scripting.html
       #
       def delete_script(arguments={})
         raise ArgumentError, "Required argument 'id' missing"   unless arguments[:id]
@@ -25,8 +24,8 @@ module Elasticsearch
       #
       # @since 6.2.0
       ParamsRegistry.register(:delete_script, [
-          :version,
-          :version_type ].freeze)
+          :timeout,
+          :master_timeout ].freeze)
     end
   end
 end