elasticsearch-api 7.4.0 → 7.5.0.pre.pre

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

@@ -6,68 +6,47 @@ module Elasticsearch
   module API
     module Cat
       module Actions
-
-        # Return document counts for the entire cluster or specific indices
-        #
-        # @example Display number of documents in the cluster
-        #
-        #     puts client.cat.count
-        #
-        # @example Display number of documents in an index
-        #
-        #     puts client.cat.count index: 'index-a'
-        #
-        # @example Display number of documents in a list of indices
-        #
-        #     puts client.cat.count index: ['index-a', 'index-b']
-        #
-        # @example Display header names in the output
-        #
-        #     puts client.cat.count v: true
-        #
-        # @example Return the information as Ruby objects
-        #
-        #     client.cat.count format: 'json'
+        # Provides quick access to the document count of the entire cluster, or individual indices.
         #
         # @option arguments [List] :index A comma-separated list of index names to limit the returned information
-        # @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 [String] :format a short version of the Accept header, e.g. json, yaml
+        # @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] :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 [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @option arguments [Boolean] :v Verbose mode. Display column headers
+
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/cat-count.html
         #
-        def count(arguments={})
-          index = arguments.delete(:index)
+        def count(arguments = {})
+          arguments = arguments.clone
 
-          method = HTTP_GET
-
-          path   = Utils.__pathify '_cat/count', Utils.__listify(index)
+          _index = arguments.delete(:index)
 
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _index
+                     "_cat/count/#{Utils.__listify(_index)}"
+                   else
+                     "_cat/count"
+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(:count, [
-            :format,
-            :local,
-            :master_timeout,
-            :h,
-            :help,
-            :s,
-            :v ].freeze)
+          :format,
+          :h,
+          :help,
+          :s,
+          :v
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,54 +6,52 @@ module Elasticsearch
   module API
     module Cat
       module Actions
-
-        # Return information about field data usage across the cluster
-        #
-        # @example Return the total size of field data
-        #
-        #     client.cat.fielddata
+        # Shows how much heap memory is currently being used by fielddata on every data node in the cluster.
         #
-        # @example Return both the total size and size for specific fields
-        #
-        #     client.cat.fielddata fields: 'title,body'
-        #
-        # @option arguments [List] :fields A comma-separated list of fields to include in the output
-        # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, m, g)
-        # @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] :fields A comma-separated list of fields to return the fielddata size
+        # @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
+        # @option arguments [List] :fields A comma-separated list of fields to return in the output
+
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/cat-fielddata.html
         #
-        def fielddata(arguments={})
-          fields = arguments.delete(:fields)
+        def fielddata(arguments = {})
+          arguments = arguments.clone
 
-          method = HTTP_GET
-          path   = Utils.__pathify "_cat/fielddata", Utils.__listify(fields)
+          _fields = arguments.delete(:fields)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _fields
+                     "_cat/fielddata/#{Utils.__listify(_fields)}"
+                   else
+                     "_cat/fielddata"
+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(:fielddata, [
-            :format,
-            :bytes,
-            :local,
-            :master_timeout,
-            :h,
-            :help,
-            :s,
-            :v,
-            :fields ].freeze)
+          :format,
+          :bytes,
+          :h,
+          :help,
+          :s,
+          :v,
+          :fields
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,56 +6,46 @@ module Elasticsearch
   module API
     module Cat
       module Actions
-
-        # Display a terse version of the {Elasticsearch::API::Cluster::Actions#health} API output
-        #
-        # @example Display cluster health
-        #
-        #     puts client.cat.health
-        #
-        # @example Display header names in the output
-        #
-        #     puts client.cat.health v: true
-        #
-        # @example Return the information as Ruby objects
+        # Returns a concise representation of the cluster health.
         #
-        #     client.cat.health format: 'json'
-        #
-        # @option arguments [Boolean] :ts Whether to display timestamp information
-        # @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 [String] :format a short version of the Accept header, e.g. json, yaml
+        # @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] :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 [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @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] :ts Set to false to disable timestamping
+        # @option arguments [Boolean] :v Verbose mode. Display column headers
+
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/cat-health.html
         #
-        def health(arguments={})
-          method = HTTP_GET
+        def health(arguments = {})
+          arguments = arguments.clone
+
+          method = Elasticsearch::API::HTTP_GET
           path   = "_cat/health"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          params = Elasticsearch::API::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(:health, [
-            :format,
-            :local,
-            :master_timeout,
-            :h,
-            :help,
-            :s,
-            :ts,
-            :v ].freeze)
+          :format,
+          :h,
+          :help,
+          :s,
+          :time,
+          :ts,
+          :v
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,29 +6,33 @@ module Elasticsearch
   module API
     module Cat
       module Actions
-
-        # Help information for the Cat API
+        # Returns help for the Cat APIs.
         #
         # @option arguments [Boolean] :help Return help information
+        # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
+
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/cat.html
         #
-        def help(arguments={})
-          method = HTTP_GET
+        def help(arguments = {})
+          arguments = arguments.clone
+
+          method = Elasticsearch::API::HTTP_GET
           path   = "_cat"
           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(:help, [
-            :help,
-            :s ].freeze)
+          :help,
+          :s
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,84 +6,67 @@ module Elasticsearch
   module API
     module Cat
       module Actions
-
-        # Return the most important statistics about indices, across the cluster nodes
-        #
-        # Use the `help` parameter to display available statistics.
-        #
-        # @example Display information for all indices
-        #
-        #     puts client.cat.indices
-        #
-        # @example Display information for a specific index
-        #
-        #     puts client.cat.indices index: 'index-a'
-        #
-        # @example Display information for indices matching a pattern
-        #
-        #     puts client.cat.indices index: 'index-*'
-        #
-        # @example Display header names in the output
-        #
-        #     puts client.cat.indices v: true
-        #
-        # @example Display only specific columns in the output (see the `help` parameter)
-        #
-        #     puts client.cat.indices h: ['index', 'docs.count', 'fielddata.memory_size', 'filter_cache.memory_size']
-        #
-        # @example Display only specific columns in the output, using the short names
-        #
-        #     puts client.cat.indices h: 'i,dc,ss,mt', v: true
-        #
-        # @example Return the information as Ruby objects
-        #
-        #     client.cat.indices format: 'json'
+        # Returns information about indices: number of primaries and replicas, document counts, disk size, ...
         #
         # @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 [Boolean] :pri Limit the returned information on primary shards only (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] :health A health status ("green", "yellow", or "red" to filter only indices
-        #                                    matching the specified health status (options: green, yellow, red)
-        # @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,m,g)
+
+        # @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 [String] :health A health status ("green", "yellow", or "red" to filter only indices matching the specified health status
+        #   (options: green,yellow,red)
+
+        # @option arguments [Boolean] :help Return help information
+        # @option arguments [Boolean] :pri Set to true to return stats only for primary shards
+        # @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
+        # @option arguments [Boolean] :include_unloaded_segments If set to true segment stats will include stats for segments that are not currently loaded into memory
+
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/cat-indices.html
         #
-        def indices(arguments={})
-          index = arguments.delete(:index)
-          method = HTTP_GET
+        def indices(arguments = {})
+          arguments = arguments.clone
 
-          path   = Utils.__pathify '_cat/indices', Utils.__listify(index)
+          _index = arguments.delete(:index)
 
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _index
+                     "_cat/indices/#{Utils.__listify(_index)}"
+                   else
+                     "_cat/indices"
+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(:indices, [
-            :format,
-            :bytes,
-            :local,
-            :master_timeout,
-            :h,
-            :health,
-            :help,
-            :pri,
-            :s,
-            :v ].freeze)
+          :format,
+          :bytes,
+          :local,
+          :master_timeout,
+          :h,
+          :health,
+          :help,
+          :pri,
+          :s,
+          :time,
+          :v,
+          :include_unloaded_segments
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,53 +6,43 @@ module Elasticsearch
   module API
     module Cat
       module Actions
-
-        # Display basic information about the master node
-        #
-        # @example
-        #
-        #     puts client.cat.master
-        #
-        # @example Display header names in the output
-        #
-        #     puts client.cat.master v: true
-        #
-        # @example Return the information as Ruby objects
+        # Returns information about the master node.
         #
-        #     client.cat.master format: 'json'
-        #
-        # @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 [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-master.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/cat-master.html
         #
-        def master(arguments={})
-          method = HTTP_GET
+        def master(arguments = {})
+          arguments = arguments.clone
+
+          method = Elasticsearch::API::HTTP_GET
           path   = "_cat/master"
           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(:master, [
-            :format,
-            :local,
-            :master_timeout,
-            :h,
-            :help,
-            :s,
-            :v ].freeze)
+          :format,
+          :local,
+          :master_timeout,
+          :h,
+          :help,
+          :s,
+          :v
+        ].freeze)
+end
       end
-    end
   end
 end