elasticsearch-api 7.3.0 → 7.5.0

data/lib/elasticsearch/api/actions/cat/tasks.rb

@@ -6,45 +6,51 @@ module Elasticsearch
   module API
     module Cat
       module Actions
-
-        # Return currently running tasks
+        # Returns information about the tasks currently executing on one or more nodes in the cluster.
         #
         # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
         # @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] :actions A comma-separated list of actions that should be returned. Leave empty to return all.
         # @option arguments [Boolean] :detailed Return detailed task information (default: false)
-        # @option arguments [String] :parent_node Return tasks with specified parent node.
         # @option arguments [Number] :parent_task Return tasks with specified parent task id. Set to -1 to return all.
         # @option arguments [List] :h Comma-separated list of column names to display
         # @option arguments [Boolean] :help Return help information
-        # @option arguments [Boolean] :v Verbose mode. Display column headers
         # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
+        # @option arguments [String] :time The unit in which to display time values
+        #   (options: d (Days),h (Hours),m (Minutes),s (Seconds),ms (Milliseconds),micros (Microseconds),nanos (Nanoseconds))
+
+        # @option arguments [Boolean] :v Verbose mode. Display column headers
+
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/tasks.html
         #
-        def tasks(arguments={})
-          method = 'GET'
+        def tasks(arguments = {})
+          arguments = arguments.clone
+
+          method = Elasticsearch::API::HTTP_GET
           path   = "_cat/tasks"
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
 
+          body = nil
           perform_request(method, path, params, body).body
         end
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.1.1
+        # @since 6.2.0
         ParamsRegistry.register(:tasks, [
-            :format,
-            :node_id,
-            :actions,
-            :detailed,
-            :parent_task,
-            :h,
-            :help,
-            :s,
-            :v ].freeze)
+          :format,
+          :node_id,
+          :actions,
+          :detailed,
+          :parent_task,
+          :h,
+          :help,
+          :s,
+          :time,
+          :v
+        ].freeze)
+end
       end
-    end
   end
 end

data/lib/elasticsearch/api/actions/cat/templates.rb

@@ -6,8 +6,7 @@ module Elasticsearch
   module API
     module Cat
       module Actions
-
-        # Returns information about existing templates
+        # Returns information about existing templates.
         #
         # @option arguments [String] :name A pattern that returned template names must match
         # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
@@ -15,33 +14,42 @@ module Elasticsearch
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         # @option arguments [List] :h Comma-separated list of column names to display
         # @option arguments [Boolean] :help Return help information
-        # @option arguments [Boolean] :v Verbose mode. Display column headers
         # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
+        # @option arguments [Boolean] :v Verbose mode. Display column headers
+
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-templates.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/cat-templates.html
         #
-        def templates(arguments={})
-          method = HTTP_GET
-          path   = "_cat/templates"
+        def templates(arguments = {})
+          arguments = arguments.clone
+
+          _name = arguments.delete(:name)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _name
+                     "_cat/templates/#{Utils.__listify(_name)}"
+                   else
+                     "_cat/templates"
+end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
 
+          body = nil
           perform_request(method, path, params, body).body
         end
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.1.1
+        # @since 6.2.0
         ParamsRegistry.register(:templates, [
-            :name,
-            :format,
-            :local,
-            :master_timeout,
-            :h,
-            :help,
-            :s,
-            :v ].freeze)
+          :format,
+          :local,
+          :master_timeout,
+          :h,
+          :help,
+          :s,
+          :v
+        ].freeze)
+end
       end
-    end
   end
 end

data/lib/elasticsearch/api/actions/cat/thread_pool.rb

@@ -6,66 +6,56 @@ module Elasticsearch
   module API
     module Cat
       module Actions
-
-        # Display thread pool statistics across nodes (use the `help` parameter to display a list
-        # of avaialable thread pools)
-        #
-        # @example Display information about all thread pools across nodes
-        #
-        #     puts client.cat.thread_pool
-        #
-        # @example Display header names in the output
-        #
-        #     puts client.cat.thread_pool v: true
-        #
-        # @example Display information about the indexing thread pool
-        #
-        #     puts client.cat.thread_pool h: %w(h ip index.active index.size index.queue index.rejected), v: true
-        #
-        # @example Display information about the indexing and search threads, using the short names
-        #
-        #     puts client.cat.thread_pool h: 'host,ia,is,iq,ir,sa,ss,sq,sr', v: true
+        # Returns cluster-wide thread pool statistics per node.
+        # By default the active, queue and rejected statistics are returned for all thread pools.
         #
-        # @option arguments [Boolean] :full_id Display the complete node ID
+        # @option arguments [List] :thread_pool_patterns A comma-separated list of regular-expressions to filter the thread pools in the output
+        # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
         # @option arguments [String] :size The multiplier in which to display values
-        #                                  (Options: k, m, g, t, p)
-        # @option arguments [List] :thread_pool_patterns A comma-separated list of regular expressions to filter
-        #                                                the thread pools in the output
-        # @option arguments [List] :h Comma-separated list of column names to display -- see the `help` argument
-        # @option arguments [Boolean] :v Display column headers as part of the output
-        # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
-        # @option arguments [String] :format The output format. Options: 'text', 'json'; default: 'text'
-        # @option arguments [Boolean] :help Return information about headers
-        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
-        #                                    (default: false)
+        #   (options: ,k,m,g,t,p)
+
+        # @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 [List] :h Comma-separated list of column names to display
+        # @option arguments [Boolean] :help Return help information
+        # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
+        # @option arguments [Boolean] :v Verbose mode. Display column headers
+
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/cat-thread-pool.html
         #
-        def thread_pool(arguments={})
-          method = HTTP_GET
-          path   = "_cat/thread_pool"
+        def thread_pool(arguments = {})
+          arguments = arguments.clone
+
+          _thread_pool_patterns = arguments.delete(:thread_pool_patterns)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _thread_pool_patterns
+                     "_cat/thread_pool/#{Utils.__listify(_thread_pool_patterns)}"
+                   else
+                     "_cat/thread_pool"
+end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           params[:h] = Utils.__listify(params[:h]) if params[:h]
-          body   = nil
 
+          body = nil
           perform_request(method, path, params, body).body
         end
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.1.1
+        # @since 6.2.0
         ParamsRegistry.register(:thread_pool, [
-            :format,
-            :size,
-            :local,
-            :master_timeout,
-            :h,
-            :help,
-            :s,
-            :v,
-            :thread_pool_patterns].freeze)
+          :format,
+          :size,
+          :local,
+          :master_timeout,
+          :h,
+          :help,
+          :s,
+          :v
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -5,22 +5,35 @@
 module Elasticsearch
   module API
     module Actions
-
-      # Abort a particular scroll search and clear all the resources associated with it.
+      # Explicitly clears the search context for a scroll.
       #
-      # @option arguments [List] :scroll_id A comma-separated list of scroll IDs to clear
+      # @option arguments [List] :scroll_id A comma-separated list of scroll IDs to clear   *Deprecated*
+
       # @option arguments [Hash] :body A comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter
       #
-      # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-scroll.html
+      # *Deprecation notice*:
+      # A scroll id can be quite large and should be specified as part of the body
+      # Deprecated since version 7.0.0
+      #
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/search-request-body.html#_clear_scroll_api
       #
-      def clear_scroll(arguments={})
+      def clear_scroll(arguments = {})
+        arguments = arguments.clone
+
+        _scroll_id = arguments.delete(:scroll_id)
+
         method = Elasticsearch::API::HTTP_DELETE
-        path   = Utils.__pathify '_search/scroll', Utils.__listify(arguments.delete(:scroll_id))
+        path   = if _scroll_id
+                   "_search/scroll/#{Utils.__listify(_scroll_id)}"
+                 else
+                   "_search/scroll"
+end
         params = {}
-        body   = arguments[:body]
 
+        body = arguments[:body]
         perform_request(method, path, params, body).body
       end
     end
-  end
+    end
 end

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

@@ -6,32 +6,34 @@ module Elasticsearch
   module API
     module Cluster
       module Actions
-
-        # Return the information about why a shard is or isn't allocated
+        # Provides explanations for shard allocations in the cluster.
         #
-        # @option arguments [Hash] :body The index, shard, and primary flag to explain. Empty means 'explain the first unassigned shard'
         # @option arguments [Boolean] :include_yes_decisions Return 'YES' decisions in explanation (default: false)
-        # @option arguments [Boolean] :include_disk_info Return information about disk usage and shard sizes
-        #                                                (default: false)
+        # @option arguments [Boolean] :include_disk_info Return information about disk usage and shard sizes (default: false)
+
+        # @option arguments [Hash] :body The index, shard, and primary flag to explain. Empty means 'explain the first unassigned shard'
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-allocation-explain.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/cluster-allocation-explain.html
         #
-        def allocation_explain(arguments={})
-          method = 'GET'
+        def allocation_explain(arguments = {})
+          arguments = arguments.clone
+
+          method = Elasticsearch::API::HTTP_GET
           path   = "_cluster/allocation/explain"
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = arguments[:body]
 
+          body = arguments[:body]
           perform_request(method, path, params, body).body
         end
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.1.1
+        # @since 6.2.0
         ParamsRegistry.register(:allocation_explain, [
-            :include_yes_decisions,
-            :include_disk_info ].freeze)
+          :include_yes_decisions,
+          :include_disk_info
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,37 +6,37 @@ module Elasticsearch
   module API
     module Cluster
       module Actions
-
-        # Get the cluster settings (previously set with {Cluster::Actions#put_settings})
-        #
-        # @example Get cluster settings
-        #
-        #     client.cluster.get_settings
+        # Returns cluster settings.
         #
         # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
-        # @option arguments [Boolean] :include_defaults Whether to return all default clusters setting
-        #                                               (default: false)
+        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [Boolean] :include_defaults Whether to return all default clusters setting.
+
         #
-        # @see http://elasticsearch.org/guide/reference/api/admin-cluster-update-settings/
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/cluster-update-settings.html
         #
-        def get_settings(arguments={})
-          method = HTTP_GET
+        def get_settings(arguments = {})
+          arguments = arguments.clone
+
+          method = Elasticsearch::API::HTTP_GET
           path   = "_cluster/settings"
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
 
+          body = nil
           perform_request(method, path, params, body).body
         end
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.1.1
+        # @since 6.2.0
         ParamsRegistry.register(:get_settings, [
-            :flat_settings,
-            :master_timeout,
-            :timeout,
-            :include_defaults ].freeze)
+          :flat_settings,
+          :master_timeout,
+          :timeout,
+          :include_defaults
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,67 +6,65 @@ module Elasticsearch
   module API
     module Cluster
       module Actions
-
-        # Returns information about cluster "health".
-        #
-        # @example Get the cluster health information
-        #
-        #     client.cluster.health
-        #
-        # @example Block the request until the cluster is in the "yellow" state
+        # Returns basic information about the health of the cluster.
         #
-        #     client.cluster.health wait_for_status: 'yellow'
-        #
-        # @option arguments [String] :index Limit the information returned to a specific index
+        # @option arguments [List] :index Limit the information returned to a specific index
+        # @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 [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)
+        #   (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_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)
-        # @option arguments [List] :wait_for_events Wait until all currently queued events with the given priorty
-        #                                           are processed (immediate, urgent, high, normal, low, languid)
+        #   (options: green,yellow,red)
+
         #
-        # @see http://elasticsearch.org/guide/reference/api/admin-cluster-health/
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/cluster-health.html
         #
-        def health(arguments={})
+        def health(arguments = {})
           arguments = arguments.clone
-          index     = arguments.delete(:index)
-          method = HTTP_GET
-          path   = Utils.__pathify "_cluster/health", Utils.__listify(index)
 
+          _index = arguments.delete(:index)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _index
+                     "_cluster/health/#{Utils.__listify(_index)}"
+                   else
+                     "_cluster/health"
+end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body = nil
 
+          body = nil
           perform_request(method, path, params, body).body
         end
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.1.1
+        # @since 6.2.0
         ParamsRegistry.register(:health, [
-            :expand_wildcards,
-            :level,
-            :local,
-            :master_timeout,
-            :timeout,
-            :wait_for_active_shards,
-            :wait_for_nodes,
-            :wait_for_events,
-            :wait_for_no_relocating_shards,
-            :wait_for_no_initializing_shards,
-            :wait_for_status ].freeze)
+          :expand_wildcards,
+          :level,
+          :local,
+          :master_timeout,
+          :timeout,
+          :wait_for_active_shards,
+          :wait_for_nodes,
+          :wait_for_events,
+          :wait_for_no_relocating_shards,
+          :wait_for_no_initializing_shards,
+          :wait_for_status
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -7,7 +7,6 @@ module Elasticsearch
     module Cluster
       module Actions
         module ParamsRegistry
-
           extend self
 
           # A Mapping of all the actions to their list of valid params.

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

@@ -6,36 +6,34 @@ module Elasticsearch
   module API
     module Cluster
       module Actions
-
-        # Returns a list of any cluster-level changes (e.g. create index, update mapping, allocate or fail shard)
-        # which have not yet been executed and are queued up.
-        #
-        # @example Get a list of currently queued up tasks in the cluster
-        #
-        #     client.cluster.pending_tasks
+        # Returns a list of any cluster-level changes (e.g. create index, update mapping,
+        # allocate or fail shard) which have not yet been executed.
         #
-        # @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 https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-pending.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/cluster-pending.html
         #
-        def pending_tasks(arguments={})
-          method = HTTP_GET
+        def pending_tasks(arguments = {})
+          arguments = arguments.clone
+
+          method = Elasticsearch::API::HTTP_GET
           path   = "_cluster/pending_tasks"
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
 
+          body = nil
           perform_request(method, path, params, body).body
         end
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.1.1
+        # @since 6.2.0
         ParamsRegistry.register(:pending_tasks, [
-            :local,
-            :master_timeout ].freeze)
+          :local,
+          :master_timeout
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,35 +6,38 @@ module Elasticsearch
   module API
     module Cluster
       module Actions
-
-        # Update cluster settings.
-        #
-        # @example Disable shard allocation in the cluster until restart
+        # Updates the cluster settings.
         #
-        #     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 [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] :body The settings to be updated. Can be either `transient` or `persistent` (survives cluster restart). (*Required*)
         #
-        # @see http://elasticsearch.org/guide/reference/api/admin-cluster-update-settings/
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/cluster-update-settings.html
         #
-        def put_settings(arguments={})
-          method = HTTP_PUT
+        def put_settings(arguments = {})
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+          arguments = arguments.clone
+
+          method = Elasticsearch::API::HTTP_PUT
           path   = "_cluster/settings"
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = arguments[:body] || {}
 
+          body = arguments[:body] || {}
           perform_request(method, path, params, body).body
         end
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.1.1
+        # @since 6.2.0
         ParamsRegistry.register(:put_settings, [
-            :flat_settings,
-            :master_timeout,
-            :timeout ].freeze)
+          :flat_settings,
+          :master_timeout,
+          :timeout
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,21 +6,23 @@ module Elasticsearch
   module API
     module Cluster
       module Actions
-
-        # Returns the configured remote cluster information
+        # Returns the information about configured remote clusters.
         #
+
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-remote-info.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/cluster-remote-info.html
         #
-        def remote_info(arguments={})
+        def remote_info(arguments = {})
+          arguments = arguments.clone
+
           method = Elasticsearch::API::HTTP_GET
           path   = "_remote/info"
           params = {}
-          body   = nil
 
+          body = nil
           perform_request(method, path, params, body).body
         end
+end
       end
-    end
   end
 end