elasticsearch-api 7.8.1 → 7.9.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c9c47132b13f15a6bb13394a409217a1e91101687e7201e44a2c28cf90ad78b
-  data.tar.gz: 3a522cd5bdcdabd6adb0c6ab2baa3871c769f887ebcae75491cdd98e8cbde9a2
+  metadata.gz: 98f0e5f1eb4c215d5737c3f399c889106edd43c3706e32475ca2bce1f9175cc4
+  data.tar.gz: d4b05f1c0c9cc446924101c66e32b4e9af79e58dfa482f3b638a76c3cacb9461
 SHA512:
-  metadata.gz: 047757a9940d621a4e1b71241d96f4090e8d603423f94a60d43c6967f269c54a3468884ef407e8eaa4ef2c337c56394b3dbdd08c3e840e8dd7aa15cf3675d754
-  data.tar.gz: 366ee588648c6b3ee712a975fb5c9dfed47b3d59ba04a8e6e26169736bf26f4f108ef28048004ea76911090a6e4130ac7ec1b8635332ed2702b249e36e7dfa6b
+  metadata.gz: 1bebaaa45f3a81b07fef48eb3b04c2ca87214ede4cd19208d2e8f3a3dc817ead73bbfaacad3d576903ff374d6b0ae3e1670fecca0d4492ea55506361ffb86880
+  data.tar.gz: ea53b48d7671779d23c7ca597a7f31470d990cdbedba83bf29aa315e1f16ad453971097bcbf89573638b3e3f3ef1454f648ccc6c845c7fd8d58d127603093049

data/lib/elasticsearch/api.rb

@@ -71,7 +71,8 @@ module Elasticsearch
                 Elasticsearch::API::Snapshot,
                 Elasticsearch::API::Tasks,
                 Elasticsearch::API::Cat,
-                Elasticsearch::API::Remote
+                Elasticsearch::API::Remote,
+                Elasticsearch::API::DanglingIndices
     end
 
     # The serializer class

data/lib/elasticsearch/api/actions/bulk.rb

@@ -25,6 +25,7 @@ module Elasticsearch
       # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the bulk operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
       # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes.
       #   (options: true,false,wait_for)
+
       # @option arguments [String] :routing Specific routing value
       # @option arguments [Time] :timeout Explicit operation timeout
       # @option arguments [String] :type Default document type for items which don't provide one
@@ -33,9 +34,10 @@ module Elasticsearch
       # @option arguments [List] :_source_includes Default list of fields to extract and return from the _source field, can be overridden on each sub-request
       # @option arguments [String] :pipeline The pipeline id to preprocess incoming documents with
       # @option arguments [Hash] :headers Custom HTTP headers
-      # @option arguments [Hash] :body The operation definition and data (action-data pairs), separated by newlines (*Required*)
+      # @option arguments [String|Array] :body The operation definition and data (action-data pairs), separated by newlines. Array of Strings, Header/Data pairs,
+      # or the conveniency "combined" format can be passed, refer to Elasticsearch::API::Utils.__bulkify documentation.
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/docs-bulk.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/docs-bulk.html
       #
       def bulk(arguments = {})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -55,7 +57,7 @@ module Elasticsearch
                    "#{Utils.__listify(_index)}/_bulk"
                  else
                    "_bulk"
-  end
+                 end
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
         body = arguments[:body]
@@ -63,7 +65,7 @@ module Elasticsearch
           payload = Elasticsearch::API::Utils.__bulkify(body)
         else
           payload = body
-      end
+        end
 
         headers.merge!("Content-Type" => "application/x-ndjson")
         perform_request(method, path, params, payload, headers).body
@@ -84,5 +86,5 @@ module Elasticsearch
         :pipeline
       ].freeze)
     end
-    end
+  end
 end

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

@@ -30,9 +30,10 @@ module Elasticsearch
         # @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/7.8/cat-alias.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-alias.html
         #
         def aliases(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -46,7 +47,7 @@ module Elasticsearch
                      "_cat/aliases/#{Utils.__listify(_name)}"
                    else
                      "_cat/aliases"
-      end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           params[:h] = Utils.__listify(params[:h]) if params[:h]
 
@@ -66,7 +67,7 @@ module Elasticsearch
           :v,
           :expand_wildcards
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -25,6 +25,7 @@ module Elasticsearch
         # @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
@@ -33,7 +34,7 @@ module Elasticsearch
         # @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/7.8/cat-allocation.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-allocation.html
         #
         def allocation(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -47,7 +48,7 @@ module Elasticsearch
                      "_cat/allocation/#{Utils.__listify(_node_id)}"
                    else
                      "_cat/allocation"
-      end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           params[:h] = Utils.__listify(params[:h]) if params[:h]
 
@@ -68,7 +69,7 @@ module Elasticsearch
           :s,
           :v
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -29,7 +29,7 @@ module Elasticsearch
         # @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/7.8/cat-count.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-count.html
         #
         def count(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -43,7 +43,7 @@ module Elasticsearch
                      "_cat/count/#{Utils.__listify(_index)}"
                    else
                      "_cat/count"
-      end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           params[:h] = Utils.__listify(params[:h]) if params[:h]
 
@@ -61,7 +61,7 @@ module Elasticsearch
           :s,
           :v
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -25,6 +25,7 @@ module Elasticsearch
         # @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 [List] :s Comma-separated list of column names or column aliases to sort by
@@ -32,7 +33,7 @@ module Elasticsearch
         # @option arguments [List] :fields A comma-separated list of fields to return in the output
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/cat-fielddata.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-fielddata.html
         #
         def fielddata(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -46,7 +47,7 @@ module Elasticsearch
                      "_cat/fielddata/#{Utils.__listify(_fields)}"
                    else
                      "_cat/fielddata"
-      end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = nil
@@ -65,7 +66,7 @@ module Elasticsearch
           :v,
           :fields
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -27,11 +27,12 @@ module Elasticsearch
         # @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] :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/7.8/cat-health.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-health.html
         #
         def health(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -59,7 +60,7 @@ module Elasticsearch
           :ts,
           :v
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -25,7 +25,7 @@ module Elasticsearch
         # @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/7.8/cat.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat.html
         #
         def help(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -47,7 +47,7 @@ module Elasticsearch
           :help,
           :s
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -25,23 +25,27 @@ module Elasticsearch
         # @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 [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,h,m,s,ms,micros,nanos)
+
         # @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
         # @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/7.8/cat-indices.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-indices.html
         #
         def indices(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -55,7 +59,7 @@ module Elasticsearch
                      "_cat/indices/#{Utils.__listify(_index)}"
                    else
                      "_cat/indices"
-      end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           params[:h] = Utils.__listify(params[:h]) if params[:h]
 
@@ -81,7 +85,7 @@ module Elasticsearch
           :include_unloaded_segments,
           :expand_wildcards
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -30,7 +30,7 @@ module Elasticsearch
         # @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/7.8/cat-master.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-master.html
         #
         def master(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -57,7 +57,7 @@ module Elasticsearch
           :s,
           :v
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -30,7 +30,7 @@ module Elasticsearch
         # @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/7.8/cat-nodeattrs.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-nodeattrs.html
         #
         def nodeattrs(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -57,7 +57,7 @@ module Elasticsearch
           :s,
           :v
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -23,6 +23,7 @@ module Elasticsearch
         #
         # @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 [Boolean] :local Calculate the selected nodes using the local cluster state rather than the state from master node (default: false)   *Deprecated*
@@ -32,10 +33,11 @@ module Elasticsearch
         # @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 https://www.elastic.co/guide/en/elasticsearch/reference/7.8/cat-nodes.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-nodes.html
         #
         def nodes(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -66,7 +68,7 @@ module Elasticsearch
           :time,
           :v
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -29,10 +29,11 @@ module Elasticsearch
         # @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 https://www.elastic.co/guide/en/elasticsearch/reference/7.8/cat-pending-tasks.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-pending-tasks.html
         #
         def pending_tasks(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -61,7 +62,7 @@ module Elasticsearch
           :time,
           :v
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -30,7 +30,7 @@ module Elasticsearch
         # @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/7.8/cat-plugins.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-plugins.html
         #
         def plugins(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -57,7 +57,7 @@ module Elasticsearch
           :s,
           :v
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -26,6 +26,7 @@ module Elasticsearch
         # @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 [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
@@ -33,10 +34,11 @@ module Elasticsearch
         # @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 https://www.elastic.co/guide/en/elasticsearch/reference/7.8/cat-recovery.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-recovery.html
         #
         def recovery(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -50,7 +52,7 @@ module Elasticsearch
                      "_cat/recovery/#{Utils.__listify(_index)}"
                    else
                      "_cat/recovery"
-      end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           params[:h] = Utils.__listify(params[:h]) if params[:h]
 
@@ -73,7 +75,7 @@ module Elasticsearch
           :time,
           :v
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -30,7 +30,7 @@ module Elasticsearch
         # @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/7.8/cat-repositories.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-repositories.html
         #
         def repositories(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -57,7 +57,7 @@ module Elasticsearch
           :s,
           :v
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -25,13 +25,14 @@ module Elasticsearch
         # @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 [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/7.8/cat-segments.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-segments.html
         #
         def segments(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -45,7 +46,7 @@ module Elasticsearch
                      "_cat/segments/#{Utils.__listify(_index)}"
                    else
                      "_cat/segments"
-      end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = nil
@@ -63,7 +64,7 @@ module Elasticsearch
           :s,
           :v
         ].freeze)
-end
       end
+    end
   end
 end