elasticsearch-api 7.4.0 → 7.5.0.pre.pre

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

@@ -6,43 +6,50 @@ module Elasticsearch
   module API
     module Cat
       module Actions
-
-        # Display information about the segments in the shards of an index
-        #
-        # @example Display information for all indices
-        #
-        #     puts client.cat.segments
+        # Provides low-level information about the segments in the shards of an index.
         #
         # @option arguments [List] :index A comma-separated list of index names to limit the returned information
-        # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, m, g)
+        # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
+        # @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 [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 https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/cat-segments.html
         #
-        def segments(arguments={})
-          method = 'GET'
-          path   = "_cat/segments"
+        def segments(arguments = {})
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _index
+                     "_cat/segments/#{Utils.__listify(_index)}"
+                   else
+                     "_cat/segments"
+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(:segments, [
-            :index,
-            :format,
-            :bytes,
-            :h,
-            :help,
-            :s,
-            :v ].freeze)
+          :format,
+          :bytes,
+          :h,
+          :help,
+          :s,
+          :v
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,80 +6,59 @@ module Elasticsearch
   module API
     module Cat
       module Actions
-
-        # Display shard allocation across nodes
-        #
-        # @example Display information for all indices
-        #
-        #     puts client.cat.shards
-        #
-        # @example Display information for a specific index
-        #
-        #     puts client.cat.shards index: 'index-a'
-        #
-        # @example Display information for a list of indices
-        #
-        #     puts client.cat.shards index: ['index-a', 'index-b']
-        #
-        # @example Display header names in the output
-        #
-        #     puts client.cat.shards v: true
-        #
-        # @example Display shard size in choice of units
-        #
-        #     puts client.cat.shards bytes: 'b'
-        #
-        # @example Display only specific columns in the output (see the `help` parameter)
-        #
-        #     puts client.cat.shards h: ['node', 'index', 'shard', 'prirep', 'docs', 'store', 'merges.total']
-        #
-        # @example Display only specific columns in the output, using the short names
-        #
-        #     puts client.cat.shards h: 'n,i,s,p,d,sto,mt'
-        #
-        # @example Return the information as Ruby objects
-        #
-        #     client.cat.shards format: 'json'
+        # Provides a detailed view of shard allocation on nodes.
         #
         # @option arguments [List] :index A comma-separated list of index names to limit the returned information
-        # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, m, g)
-        # @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 [String] :format a short version of the Accept header, e.g. json, yaml
+        # @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 [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-shards.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/cat-shards.html
         #
-        def shards(arguments={})
-          index = arguments.delete(:index)
-          method = HTTP_GET
-          path   = Utils.__pathify '_cat/shards', Utils.__listify(index)
+        def shards(arguments = {})
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
 
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _index
+                     "_cat/shards/#{Utils.__listify(_index)}"
+                   else
+                     "_cat/shards"
+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(:shards, [
-            :format,
-            :bytes,
-            :local,
-            :master_timeout,
-            :h,
-            :help,
-            :s,
-            :v ].freeze)
+          :format,
+          :bytes,
+          :local,
+          :master_timeout,
+          :h,
+          :help,
+          :s,
+          :time,
+          :v
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,49 +6,54 @@ module Elasticsearch
   module API
     module Cat
       module Actions
-
-        # Shows all snapshots that belong to a specific repository
-        #
-        # @example Return snapshots for 'my_repository'
-        #
-        #     client.cat.snapshots repository: 'my_repository'
-        #
-        # @example Return id, status and start_epoch for 'my_repository'
-        #
-        #     client.cat.snapshots repository: 'my_repository', h: 'id,status,start_epoch'
+        # Returns all snapshots in a specific repository.
         #
+        # @option arguments [List] :repository Name of repository from which to fetch the snapshot information
+        # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
+        # @option arguments [Boolean] :ignore_unavailable Set to true to ignore unavailable snapshots
         # @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 [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/current/cat-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/cat-snapshots.html
         #
-        def snapshots(arguments={})
-          repository = arguments.delete(:repository)
+        def snapshots(arguments = {})
+          arguments = arguments.clone
+
+          _repository = arguments.delete(:repository)
 
-          method = HTTP_GET
-          path   = Utils.__pathify "_cat/snapshots", Utils.__escape(repository)
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _repository
+                     "_cat/snapshots/#{Utils.__listify(_repository)}"
+                   else
+                     "_cat/snapshots"
+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(:snapshots, [
-            :format,
-            :ignore_unavailable,
-            :master_timeout,
-            :h,
-            :help,
-            :s,
-            :v ].freeze)
+          :format,
+          :ignore_unavailable,
+          :master_timeout,
+          :h,
+          :help,
+          :s,
+          :time,
+          :v
+        ].freeze)
+end
       end
-    end
   end
 end
-

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