elasticsearch-api 7.2.0 → 8.0.0

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

@@ -6,7 +6,7 @@
 # not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#	http://www.apache.org/licenses/LICENSE-2.0
+#   http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing,
 # software distributed under the License is distributed on an
@@ -19,70 +19,42 @@ module Elasticsearch
   module API
     module Cat
       module Actions
-
-        # Returns information about aliases, including associated routing values and filters.
-        #
-        # @example Display all aliases in the cluster
-        #
-        #     puts client.cat.aliases
-        #
-        # @example Display indices for the 'year-2013' alias
-        #
-        #     puts client.cat.aliases name: 'year-2013'
-        #
-        # @example Display header names in the output
-        #
-        #     puts client.cat.aliases v: true
-        #
-        # @example Return only the 'alias' and 'index' columns
-        #
-        #     puts client.cat.aliases h: ['alias', 'index']
-        #
-        # @example Return only the 'alias' and 'index' columns, using short names
-        #
-        #     puts client.cat.aliases h: 'a,i'
-        #
-        # @example Return the output sorted by the alias name
-        #
-        #     puts client.cat.aliases s: 'alias'
-        #
-        # @example Return the information as Ruby objects
-        #
-        #     client.cat.aliases format: 'json'
+        # Shows information about currently configured aliases to indices including filter and routing infos.
         #
         # @option arguments [List] :name A comma-separated list of alias names to return
-        # @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 [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
+        # @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
+        # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
+        # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-aliases.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-alias.html
         #
-        def aliases(arguments={})
-          name = arguments.delete(:name)
-          method = HTTP_GET
-          path   = Utils.__pathify '_cat/aliases', Utils.__listify(name)
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+        def aliases(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _name = arguments.delete(:name)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _name
+                     "_cat/aliases/#{Utils.__listify(_name)}"
+                   else
+                     "_cat/aliases"
+                   end
+          params = Utils.process_params(arguments)
           params[:h] = Utils.__listify(params[:h]) if params[:h]
-          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
-        ParamsRegistry.register(:aliases, [
-            :format,
-            :local,
-            :master_timeout,
-            :h,
-            :help,
-            :s,
-            :v ].freeze)
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
       end
     end
   end

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

@@ -6,7 +6,7 @@
 # not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#	http://www.apache.org/licenses/LICENSE-2.0
+#   http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing,
 # software distributed under the License is distributed on an
@@ -19,68 +19,43 @@ module Elasticsearch
   module API
     module Cat
       module Actions
-
-        # Return shard allocation information
-        #
-        # @example Display allocation for all nodes in the cluster
-        #
-        #     puts client.cat.allocation
-        #
-        # @example Display allocation for node with name 'node-1'
-        #
-        #     puts client.cat.allocation node_id: 'node-1'
-        #
-        # @example Display header names in the output
-        #
-        #     puts client.cat.allocation v: true
-        #
-        # @example Display only specific columns in the output (see the `help` parameter)
-        #
-        #     puts client.cat.allocation h: ['node', 'shards', 'disk.percent']
-        #
-        # @example Display only specific columns in the output, using the short names
-        #
-        #     puts client.cat.allocation h: 'n,s,dp'
-        #
-        # @example Return the information as Ruby objects
-        #
-        #     client.cat.allocation format: 'json'
+        # Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.
         #
         # @option arguments [List] :node_id A comma-separated list of node IDs or 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 [Boolean] :v Verbose mode. Display column headers
+        # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html
         #
-        def allocation(arguments={})
-          node_id = arguments.delete(:node_id)
-          method = HTTP_GET
-          path   = Utils.__pathify '_cat/allocation', Utils.__listify(node_id)
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+        def allocation(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _node_id = arguments.delete(:node_id)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _node_id
+                     "_cat/allocation/#{Utils.__listify(_node_id)}"
+                   else
+                     "_cat/allocation"
+                   end
+          params = Utils.process_params(arguments)
           params[:h] = Utils.__listify(params[:h]) if params[:h]
-          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
-        ParamsRegistry.register(:allocation, [
-            :format,
-            :bytes,
-            :local,
-            :master_timeout,
-            :h,
-            :help,
-            :s,
-            :v ].freeze)
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
       end
     end
   end

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

@@ -6,7 +6,7 @@
 # not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#	http://www.apache.org/licenses/LICENSE-2.0
+#   http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing,
 # software distributed under the License is distributed on an
@@ -19,67 +19,40 @@ 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
+        # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html
         #
-        def count(arguments={})
-          index = arguments.delete(:index)
+        def count(arguments = {})
+          headers = arguments.delete(:headers) || {}
 
-          method = HTTP_GET
+          body = nil
 
-          path   = Utils.__pathify '_cat/count', Utils.__listify(index)
+          arguments = arguments.clone
 
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          params[:h] = Utils.__listify(params[:h]) if params[:h]
+          _index = arguments.delete(:index)
 
-          body   = nil
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _index
+                     "_cat/count/#{Utils.__listify(_index)}"
+                   else
+                     "_cat/count"
+                   end
+          params = Utils.process_params(arguments)
+          params[:h] = Utils.__listify(params[:h]) if params[:h]
 
-          perform_request(method, path, params, body).body
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.1.1
-        ParamsRegistry.register(:count, [
-            :format,
-            :local,
-            :master_timeout,
-            :h,
-            :help,
-            :s,
-            :v ].freeze)
       end
     end
   end

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

@@ -6,7 +6,7 @@
 # not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#	http://www.apache.org/licenses/LICENSE-2.0
+#   http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing,
 # software distributed under the License is distributed on an
@@ -19,53 +19,40 @@ 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 [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html
         #
-        def fielddata(arguments={})
-          fields = arguments.delete(:fields)
+        def fielddata(arguments = {})
+          headers = arguments.delete(:headers) || {}
 
-          method = HTTP_GET
-          path   = Utils.__pathify "_cat/fielddata", Utils.__listify(fields)
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
+          body = nil
 
-          perform_request(method, path, params, body).body
-        end
+          arguments = arguments.clone
 
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.1.1
-        ParamsRegistry.register(:fielddata, [
-            :format,
-            :bytes,
-            :local,
-            :master_timeout,
-            :h,
-            :help,
-            :s,
-            :v,
-            :fields ].freeze)
+          _fields = arguments.delete(:fields)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _fields
+                     "_cat/fielddata/#{Utils.__listify(_fields)}"
+                   else
+                     "_cat/fielddata"
+                   end
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
       end
     end
   end

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

@@ -6,7 +6,7 @@
 # not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#	http://www.apache.org/licenses/LICENSE-2.0
+#   http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing,
 # software distributed under the License is distributed on an
@@ -19,55 +19,35 @@ 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, h, m, s, ms, micros, nanos)
+        # @option arguments [Boolean] :ts Set to false to disable timestamping
+        # @option arguments [Boolean] :v Verbose mode. Display column headers
+        # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.html
         #
-        def health(arguments={})
-          method = HTTP_GET
+        def health(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          method = Elasticsearch::API::HTTP_GET
           path   = "_cat/health"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          params = Utils.process_params(arguments)
           params[:h] = Utils.__listify(params[:h]) if params[:h]
-          body   = nil
 
-          perform_request(method, path, params, body).body
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.1.1
-        ParamsRegistry.register(:health, [
-            :format,
-            :local,
-            :master_timeout,
-            :h,
-            :help,
-            :s,
-            :ts,
-            :v ].freeze)
       end
     end
   end

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

@@ -6,7 +6,7 @@
 # not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#	http://www.apache.org/licenses/LICENSE-2.0
+#   http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing,
 # software distributed under the License is distributed on an
@@ -19,28 +19,29 @@ 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
+        # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html
         #
-        def help(arguments={})
-          method = HTTP_GET
+        def help(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          method = Elasticsearch::API::HTTP_GET
           path   = "_cat"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
+          params = Utils.process_params(arguments)
 
-          perform_request(method, path, params, body).body
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.1.1
-        ParamsRegistry.register(:help, [
-            :help,
-            :s ].freeze)
       end
     end
   end