nodes.rb in elasticsearch-api-7.5.0.pre.pre

- old
+ new
@@ -4,68 +4,56 @@
 
 module Elasticsearch
   module API
     module Cat
       module Actions
-
-        # Display information about cluster topology and nodes statistics
+        # Returns basic statistics about performance of cluster nodes.
         #
-        # @example Display basic information about nodes in the cluster (host, node name, memory usage, master, etc.)
-        #
-        #     puts client.cat.nodes
-        #
-        # @example Display header names in the output
-        #
-        #     puts client.cat.nodes v: true
-        #
-        # @example Display only specific columns in the output (see the `help` parameter)
-        #
-        #     puts client.cat.nodes h: %w(name version jdk disk.avail heap.percent load merges.total_time), v: true
-        #
-        # @example Display only specific columns in the output, using the short names
-        #
-        #     puts client.cat.nodes h: 'n,v,j,d,hp,l,mtt', v: true
-        #
-        # @example Return the information as Ruby objects
-        #
-        #     client.cat.nodes format: 'json'
-        #
+        # @option arguments [String] :bytes The unit in which to display byte values
+        #   (options: b,k,kb,m,mb,g,gb,t,tb,p,pb)
+
+        # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
         # @option arguments [Boolean] :full_id Return the full node ID instead of the shortened version (default: false)
-        # @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)
+        # @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 [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 https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/cat-nodes.html
         #
-        def nodes(arguments={})
-          method = HTTP_GET
-          path   = "_cat/nodes"
+        def nodes(arguments = {})
+          arguments = arguments.clone
 
+          method = Elasticsearch::API::HTTP_GET
+          path   = "_cat/nodes"
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          params[:h] = Utils.__listify(params[:h], :escape => false) if params[:h]
+          params[:h] = Utils.__listify(params[:h], escape: false) 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(:nodes, [
-            :format,
-            :full_id,
-            :local,
-            :master_timeout,
-            :h,
-            :help,
-            :s,
-            :v ].freeze)
+          :bytes,
+          :format,
+          :full_id,
+          :local,
+          :master_timeout,
+          :h,
+          :help,
+          :s,
+          :time,
+          :v
+        ].freeze)
+end
       end
-    end
   end
 end