elasticsearch-api 6.8.0 → 7.10.0

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

@@ -1,21 +1,25 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# 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
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 module Elasticsearch
   module API
     module Cat
       module Actions
-
-        # Display the information from the {Cluster::Actions#pending_tasks} API in a tabular format
-        #
-        # @example
-        #
-        #     puts client.cat.pending_tasks
-        #
-        # @example Display header names in the output
-        #
-        #     puts client.cat.pending_tasks v: true
-        #
-        # @example Return the information as Ruby objects
-        #
-        #     client.cat.pending_tasks format: 'json'
+        # Returns a concise representation of the cluster pending tasks.
         #
         # @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)
@@ -23,31 +27,39 @@ module Elasticsearch
         # @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, h, m, s, ms, micros, nanos)
         # @option arguments [Boolean] :v Verbose mode. Display column headers
+        # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cat-pending-tasks.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/cat-pending-tasks.html
         #
-        def pending_tasks(arguments={})
-          method = HTTP_GET
+        def pending_tasks(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          method = Elasticsearch::API::HTTP_GET
           path   = "_cat/pending_tasks"
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           params[:h] = Utils.__listify(params[:h]) if params[:h]
-          body   = nil
 
-          perform_request(method, path, params, body).body
+          body = nil
+          perform_request(method, path, params, body, headers).body
         end
 
         # Register this action with its valid params when the module is loaded.
         #
         # @since 6.2.0
         ParamsRegistry.register(:pending_tasks, [
-            :format,
-            :local,
-            :master_timeout,
-            :h,
-            :help,
-            :s,
-            :v ].freeze)
+          :format,
+          :local,
+          :master_timeout,
+          :h,
+          :help,
+          :s,
+          :time,
+          :v
+        ].freeze)
       end
     end
   end

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

@@ -1,9 +1,25 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# 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
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 module Elasticsearch
   module API
     module Cat
       module Actions
-
-        # Return information about installed plugins
+        # Returns information about installed plugins across nodes node.
         #
         # @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)
@@ -12,29 +28,35 @@ module Elasticsearch
         # @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 http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-plugins.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/cat-plugins.html
         #
-        def plugins(arguments={})
-          method = 'GET'
+        def plugins(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          method = Elasticsearch::API::HTTP_GET
           path   = "_cat/plugins"
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
 
-          perform_request(method, path, params, body).body
+          body = nil
+          perform_request(method, path, params, body, headers).body
         end
 
         # Register this action with its valid params when the module is loaded.
         #
         # @since 6.2.0
         ParamsRegistry.register(:plugins, [
-            :format,
-            :local,
-            :master_timeout,
-            :h,
-            :help,
-            :s,
-            :v ].freeze)
+          :format,
+          :local,
+          :master_timeout,
+          :h,
+          :help,
+          :s,
+          :v
+        ].freeze)
       end
     end
   end

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

@@ -1,75 +1,75 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# 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
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 module Elasticsearch
   module API
     module Cat
       module Actions
-
-        # Display information about the recovery process (allocating shards)
-        #
-        # @example Display information for all indices
-        #
-        #     puts client.cat.recovery
-        #
-        # @example Display information for a specific index
-        #
-        #     puts client.cat.recovery index: 'index-a'
-        #
-        # @example Display information for indices matching a pattern
-        #
-        #     puts client.cat.recovery index: 'index-*'
-        #
-        # @example Display header names in the output
+        # Returns information about index shard recoveries, both on-going completed.
         #
-        #     puts client.cat.recovery v: true
-        #
-        # @example Display only specific columns in the output (see the `help` parameter)
-        #
-        #     puts client.cat.recovery h: ['node', 'index', 'shard', 'percent']
-        #
-        # @example Display only specific columns in the output, using the short names
-        #
-        #     puts client.cat.recovery h: 'n,i,s,per'
-        #
-        # @example Return the information as Ruby objects
-        #
-        #     client.cat.recovery format: 'json'
-        #
-        # @option arguments [List] :index A comma-separated list of index names to limit the returned information
+        # @option arguments [List] :index Comma-separated list or wildcard expression of index names to limit the returned information
         # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
+        # @option arguments [Boolean] :active_only If `true`, the response only includes ongoing shard recoveries
         # @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 [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @option arguments [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries
         # @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, h, m, s, ms, micros, nanos)
         # @option arguments [Boolean] :v Verbose mode. Display column headers
+        # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cat-recovery.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/cat-recovery.html
         #
-        def recovery(arguments={})
-          index = arguments.delete(:index)
+        def recovery(arguments = {})
+          headers = arguments.delete(:headers) || {}
 
-          method = HTTP_GET
+          arguments = arguments.clone
 
-          path   = Utils.__pathify '_cat/recovery', Utils.__listify(index)
+          _index = arguments.delete(:index)
 
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _index
+                     "_cat/recovery/#{Utils.__listify(_index)}"
+                   else
+                     "_cat/recovery"
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           params[:h] = Utils.__listify(params[:h]) if params[:h]
 
-          body   = nil
-
-          perform_request(method, path, params, body).body
+          body = nil
+          perform_request(method, path, params, body, headers).body
         end
 
         # Register this action with its valid params when the module is loaded.
         #
         # @since 6.2.0
         ParamsRegistry.register(:recovery, [
-            :format,
-            :bytes,
-            :master_timeout,
-            :h,
-            :help,
-            :s,
-            :v ].freeze)
+          :format,
+          :active_only,
+          :bytes,
+          :detailed,
+          :h,
+          :help,
+          :index,
+          :s,
+          :time,
+          :v
+        ].freeze)
       end
     end
   end

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

@@ -1,17 +1,25 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# 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
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 module Elasticsearch
   module API
     module Cat
       module Actions
-
-        # Shows all repositories registered in a cluster
-        #
-        # @example Return list of repositories
-        #
-        #     client.cat.repositories
-        #
-        # @example Return only id for each repository
-        #
-        #     client.cat.repositories h: 'id'
+        # Returns information about snapshot repositories registered in the cluster.
         #
         # @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
@@ -20,29 +28,35 @@ module Elasticsearch
         # @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/current/cat-repositories.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/cat-repositories.html
         #
-        def repositories(arguments={})
-          method = HTTP_GET
+        def repositories(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          method = Elasticsearch::API::HTTP_GET
           path   = "_cat/repositories"
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
 
-          perform_request(method, path, params, body).body
+          body = nil
+          perform_request(method, path, params, body, headers).body
         end
 
         # Register this action with its valid params when the module is loaded.
         #
         # @since 6.2.0
         ParamsRegistry.register(:repositories, [
-            :format,
-            :local,
-            :master_timeout,
-            :h,
-            :help,
-            :s,
-            :v ].freeze)
+          :format,
+          :local,
+          :master_timeout,
+          :h,
+          :help,
+          :s,
+          :v
+        ].freeze)
       end
     end
   end

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

@@ -1,13 +1,25 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# 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
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 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] :format a short version of the Accept header, e.g. json, yaml
@@ -16,29 +28,40 @@ module Elasticsearch
         # @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 http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cat-segments.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/cat-segments.html
         #
-        def segments(arguments={})
-          method = 'GET'
-          index = arguments.delete(:index)
-          path = Utils.__pathify( '_cat/segments', Utils.__escape(index))
+        def segments(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          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
 
-          perform_request(method, path, params, body).body
+          body = nil
+          perform_request(method, path, params, body, headers).body
         end
 
         # Register this action with its valid params when the module is loaded.
         #
         # @since 6.2.0
         ParamsRegistry.register(:segments, [
-            :format,
-            :bytes,
-            :h,
-            :help,
-            :s,
-            :v ].freeze)
+          :format,
+          :bytes,
+          :h,
+          :help,
+          :s,
+          :v
+        ].freeze)
       end
     end
   end

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

@@ -1,41 +1,25 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# 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
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 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] :format a short version of the Accept header, e.g. json, yaml
@@ -45,35 +29,46 @@ module Elasticsearch
         # @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, h, m, s, ms, micros, nanos)
         # @option arguments [Boolean] :v Verbose mode. Display column headers
+        # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cat-shards.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/cat-shards.html
         #
-        def shards(arguments={})
-          index = arguments.delete(:index)
-          method = HTTP_GET
-          path   = Utils.__pathify '_cat/shards', Utils.__listify(index)
+        def shards(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          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
-
-          perform_request(method, path, params, body).body
+          body = nil
+          perform_request(method, path, params, body, headers).body
         end
 
         # Register this action with its valid params when the module is loaded.
         #
         # @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