elasticsearch-api 7.4.0 → 7.5.0.pre.pre

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

@@ -6,47 +6,43 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-
-        # Refresh the index and to make the changes (creates, updates, deletes) searchable.
-        #
-        # By default, Elasticsearch has a delay of 1 second until changes to an index are
-        # available for search; the delay is configurable, see {Indices::Actions#put_settings}.
-        #
-        # You can trigger this operation explicitly, for example when performing a sequence of commands
-        # in integration tests, or when you need to perform a manual "synchronization" of the index
-        # with an external system at given moment.
-        #
-        # @example Refresh an index named _myindex_
-        #
-        #     client.indices.refresh index: 'myindex'
-        #
-        # @note The refresh operation can adversely affect indexing throughput when used too frequently.
+        # Performs the refresh operation in one or more indices.
         #
         # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
         # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
         # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
-        # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, none, all)
+        # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
+        #   (options: open,closed,none,all)
+
         #
-        # @see https://www.elastic.co/guide/reference/api/admin-indices-refresh/
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/indices-refresh.html
         #
-        def refresh(arguments={})
-          method = HTTP_POST
-          path   = Utils.__pathify Utils.__listify(arguments[:index]), '_refresh'
+        def refresh(arguments = {})
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
 
+          method = Elasticsearch::API::HTTP_POST
+          path   = if _index
+                     "#{Utils.__listify(_index)}/_refresh"
+                   else
+                     "_refresh"
+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(:refresh, [
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards ].freeze)
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,44 +6,53 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-
-        # The rollover index API rolls an alias over to a new index when the existing index
-        # is considered to be too large or too old
+        # Updates an alias to point to a new index when the existing index
+        # is considered to be too large or too old.
         #
-        # @option arguments [String] :alias The name of the alias to rollover (*Required*)
+        # @option arguments [String] :alias The name of the alias to rollover
         # @option arguments [String] :new_index The name of the rollover index
-        # @option arguments [Hash] :body The conditions that needs to be met for executing rollover
         # @option arguments [Boolean] :include_type_name Whether a type should be included in the body of the mappings.
         # @option arguments [Time] :timeout Explicit operation timeout
         # @option arguments [Boolean] :dry_run If set to true the rollover action will only be validated but not actually performed even if a condition matches. The default is false
         # @option arguments [Time] :master_timeout Specify timeout for connection to master
         # @option arguments [String] :wait_for_active_shards Set the number of active shards to wait for on the newly created rollover index before the operation returns.
+
+        # @option arguments [Hash] :body The conditions that needs to be met for executing rollover
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-rollover-index.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/indices-rollover-index.html
         #
-        def rollover(arguments={})
+        def rollover(arguments = {})
           raise ArgumentError, "Required argument 'alias' missing" unless arguments[:alias]
+
           arguments = arguments.clone
-          source = arguments.delete(:alias)
-          target = arguments.delete(:new_index)
-          method = HTTP_POST
-          path   = Utils.__pathify Utils.__escape(source), '_rollover', Utils.__escape(target)
+
+          _alias = arguments.delete(:alias)
+
+          _new_index = arguments.delete(:new_index)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = if _alias && _new_index
+                     "#{Utils.__listify(_alias)}/_rollover/#{Utils.__listify(_new_index)}"
+                   else
+                     "#{Utils.__listify(_alias)}/_rollover"
+  end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = arguments[:body]
 
+          body = arguments[:body]
           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(:rollover, [
-            :include_type_name,
-            :timeout,
-            :dry_run,
-            :master_timeout,
-            :wait_for_active_shards ].freeze)
+          :include_type_name,
+          :timeout,
+          :dry_run,
+          :master_timeout,
+          :wait_for_active_shards
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,39 +6,46 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-
-        # Return information about segments for one or more indices.
-        #
-        # The response contains information about segment size, number of documents, deleted documents, etc.
-        # See also {Indices::Actions#optimize}.
+        # Provides low-level information about segments in a Lucene index.
         #
         # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
         # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
         # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
-        # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, none, all)
+        # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
+        #   (options: open,closed,none,all)
+
         # @option arguments [Boolean] :verbose Includes detailed memory usage by Lucene.
+
         #
-        # @see http://elasticsearch.org/guide/reference/api/admin-indices-segments/
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/indices-segments.html
         #
-        def segments(arguments={})
-          method = HTTP_GET
-          path   = Utils.__pathify Utils.__listify(arguments[:index]), '_segments'
+        def segments(arguments = {})
+          arguments = arguments.clone
 
+          _index = arguments.delete(:index)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _index
+                     "#{Utils.__listify(_index)}/_segments"
+                   else
+                     "_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, [
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards,
-            :verbose ].freeze)
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards,
+          :verbose
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,35 +6,47 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-
-        # Provides low-level information about shards (allocated nodes, exceptions, ...)
+        # Provides store information for shard copies of indices.
         #
         # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
-        # @option arguments [List] :status A comma-separated list of statuses used to filter on shards to get store information for (options: green, yellow, red, all)
+        # @option arguments [List] :status A comma-separated list of statuses used to filter on shards to get store information for
+        #   (options: green,yellow,red,all)
+
         # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
         # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
-        # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, none, all)
+        # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
+        #   (options: open,closed,none,all)
+
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shards-stores.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/indices-shards-stores.html
         #
-        def shard_stores(arguments={})
-          method = 'GET'
-          path   = Utils.__pathify Utils.__escape(arguments[:index]), "_shard_stores"
+        def shard_stores(arguments = {})
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _index
+                     "#{Utils.__listify(_index)}/_shard_stores"
+                   else
+                     "_shard_stores"
+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(:shard_stores, [
-            :status,
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards ].freeze)
+          :status,
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,41 +6,47 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-
-        # Copy an existing index into a new index with a fewer number of primary shards
+        # Allow to shrink an existing index into a new index with fewer primary shards.
         #
-        # @option arguments [String] :index The name of the source index to shrink (*Required*)
-        # @option arguments [String] :target The name of the target index to shrink into (*Required*)
-        # @option arguments [Hash] :body The configuration for the target index (`settings` and `aliases`)
+        # @option arguments [String] :index The name of the source index to shrink
+        # @option arguments [String] :target The name of the target index to shrink into
+        # @option arguments [Boolean] :copy_settings whether or not to copy settings from the source index (defaults to false)
         # @option arguments [Time] :timeout Explicit operation timeout
         # @option arguments [Time] :master_timeout Specify timeout for connection to master
         # @option arguments [String] :wait_for_active_shards Set the number of active shards to wait for on the shrunken index before the operation returns.
+
+        # @option arguments [Hash] :body The configuration for the target index (`settings` and `aliases`)
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shrink-index.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/indices-shrink-index.html
         #
-        def shrink(arguments={})
+        def shrink(arguments = {})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
           raise ArgumentError, "Required argument 'target' missing" unless arguments[:target]
+
           arguments = arguments.clone
-          source = arguments.delete(:index)
-          target = arguments.delete(:target)
 
-          method = HTTP_PUT
-          path   = Utils.__pathify(source, '_shrink', target)
+          _index = arguments.delete(:index)
+
+          _target = arguments.delete(:target)
+
+          method = Elasticsearch::API::HTTP_PUT
+          path   = "#{Utils.__listify(_index)}/_shrink/#{Utils.__listify(_target)}"
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = arguments[:body]
 
+          body = arguments[:body]
           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(:shrink, [
-            :timeout,
-            :master_timeout,
-            :wait_for_active_shards ].freeze)
+          :copy_settings,
+          :timeout,
+          :master_timeout,
+          :wait_for_active_shards
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,41 +6,47 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-
-        # The split index API allows you to split an existing index into a new index with multiple of its primary shards.
+        # Allows you to split an existing index into a new index with more primary shards.
         #
-        # @option arguments [String] :index The name of the source index to split (*Required*)
-        # @option arguments [String] :target The name of the target index to split into (*Required*)
-        # @option arguments [Hash] :body The configuration for the target index (`settings` and `aliases`)
+        # @option arguments [String] :index The name of the source index to split
+        # @option arguments [String] :target The name of the target index to split into
+        # @option arguments [Boolean] :copy_settings whether or not to copy settings from the source index (defaults to false)
         # @option arguments [Time] :timeout Explicit operation timeout
         # @option arguments [Time] :master_timeout Specify timeout for connection to master
         # @option arguments [String] :wait_for_active_shards Set the number of active shards to wait for on the shrunken index before the operation returns.
+
+        # @option arguments [Hash] :body The configuration for the target index (`settings` and `aliases`)
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-split-index.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/indices-split-index.html
         #
-        def split(arguments={})
+        def split(arguments = {})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
           raise ArgumentError, "Required argument 'target' missing" unless arguments[:target]
+
           arguments = arguments.clone
-          source = arguments.delete(:index)
-          target = arguments.delete(:target)
+
+          _index = arguments.delete(:index)
+
+          _target = arguments.delete(:target)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = Utils.__pathify Utils.__escape(source), '_split', Utils.__escape(target)
-          params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = arguments[:body]
+          path   = "#{Utils.__listify(_index)}/_split/#{Utils.__listify(_target)}"
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
+          body = arguments[:body]
           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(:split, [
-            :timeout,
-            :master_timeout,
-            :wait_for_active_shards ].freeze)
+          :copy_settings,
+          :timeout,
+          :master_timeout,
+          :wait_for_active_shards
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,129 +6,78 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-
-        # Return statistical information about one or more indices.
-        #
-        # The response contains comprehensive statistical information about metrics related to index:
-        # how much time did indexing, search and other operations take, how much disk space it takes,
-        # how much memory filter caches or field data require, etc.
-        #
-        # @example Get all available statistics for all indices
-        #
-        #     client.indices.stats
-        #
-        # @example Get statistics for a single index
-        #
-        #     client.indices.stats index: 'foo'
-        #
-        # @example Get statistics about documents and disk size for multiple indices
-        #
-        #     client.indices.stats index: ['foo', 'bar'], docs: true, store: true
-        #
-        # @example Get statistics about filter cache and field data for all fields
-        #
-        #     client.indices.stats fielddata: true, filter_cache: true
-        #
-        # @example Get statistics about filter cache and field data for specific fields
-        #
-        #     client.indices.stats fielddata: true, filter_cache: true, fields: 'created_at,tags'
-        #
-        # @example Get statistics about filter cache and field data per field for all fields
+        # Provides statistics on operations happening in an index.
         #
-        #     client.indices.stats fielddata: true, filter_cache: true, fields: '*'
-        #
-        # @example Get statistics about searches, with segmentation for different search groups
-        #
-        #     client.indices.stats search: true, groups: ['groupA', 'groupB']
-        #
-        # @option arguments [Boolean] :docs Return information about indexed and deleted documents
-        # @option arguments [Boolean] :fielddata Return information about field data
-        # @option arguments [Boolean] :fields A comma-separated list of fields for `fielddata` metric (supports wildcards)
-        # @option arguments [Boolean] :filter_cache Return information about filter cache
-        # @option arguments [Boolean] :flush Return information about flush operations
-        # @option arguments [Boolean] :get Return information about get operations
-        # @option arguments [Boolean] :groups A comma-separated list of search groups for `search` statistics
-        # @option arguments [Boolean] :id_cache Return information about ID cache
-        # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string
-        #                                 to perform the operation on all indices
-        # @option arguments [Boolean] :indexing Return information about indexing operations
+        # @option arguments [List] :metric Limit the information returned the specific metrics.
+        #   (options: _all,completion,docs,fielddata,query_cache,flush,get,indexing,merge,request_cache,refresh,search,segments,store,warmer,suggest)
+
+        # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
+        # @option arguments [List] :completion_fields A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
+        # @option arguments [List] :fielddata_fields A comma-separated list of fields for `fielddata` index metric (supports wildcards)
+        # @option arguments [List] :fields A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)
+        # @option arguments [List] :groups A comma-separated list of search groups for `search` index metric
         # @option arguments [String] :level Return stats aggregated at cluster, index or shard level
-        #                                   (Options: cluster, indices, shards)
-        # @option arguments [List] :types A comma-separated list of document types to include in the `indexing` info
-        # @option arguments [Boolean] :merge Return information about merge operations
-        # @option arguments [List] :metric Limit the information returned the specific metrics
-        #                                  (_all, completion, docs, fielddata, filter_cache, flush, get,
-        #                                  id_cache, indexing, merge, percolate, refresh, search, segments,
-        #                                  store, warmer, suggest)
-        # @option arguments [Boolean] :refresh Return information about refresh operations
-        # @option arguments [Boolean] :search Return information about search operations; use the `groups` parameter to
-        #                                     include information for specific search groups
-        # @option arguments [List] :groups A comma-separated list of search groups to include in the `search` statistics
-        # @option arguments [Boolean] :suggest Return information about suggest statistics
-        # @option arguments [Boolean] :store Return information about the size of the index
-        # @option arguments [Boolean] :warmer Return information about warmers
-        # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
-        #                                                 unavailable (missing, closed, etc)
-        # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into
-        #                                               no concrete indices. (This includes `_all` string or when no
-        #                                               indices have been specified)
-        # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that
-        #                                              are open, closed or both. (options: open, closed)
-        #
-        # @option arguments [Boolean] :include_segment_file_sizes Whether to report the aggregated disk usage of each one of the Lucene index files. Only applies if segment stats are requested. (default: false)
+        #   (options: cluster,indices,shards)
+
+        # @option arguments [List] :types A comma-separated list of document types for the `indexing` index metric
+        # @option arguments [Boolean] :include_segment_file_sizes Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested)
+        # @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,none,all)
+
+        # @option arguments [Boolean] :forbid_closed_indices If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices
+
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-stats.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/indices-stats.html
         #
-        def stats(arguments={})
+        def stats(arguments = {})
           method = HTTP_GET
           parts  = Utils.__extract_parts arguments, ParamsRegistry.get(:stats_parts)
           path   = Utils.__pathify Utils.__listify(arguments[:index]), '_stats', Utils.__listify(parts)
-
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(:stats_params)
           params[:fields] = Utils.__listify(params[:fields], :escape => false) if params[:fields]
           params[:groups] = Utils.__listify(params[:groups], :escape => false) if params[:groups]
 
-          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(:stats_params, [
-            :fields,
-            :completion_fields,
-            :fielddata_fields,
-            :groups,
-            :level,
-            :types,
-            :ignore_indices,
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards,
-            :include_segment_file_sizes,
-            :include_unloaded_segments,
-            :forbid_closed_indices ].freeze)
+          :completion_fields,
+          :fielddata_fields,
+          :fields,
+          :groups,
+          :level,
+          :types,
+          :include_segment_file_sizes,
+          :include_unloaded_segments,
+          :expand_wildcards,
+          :forbid_closed_indices
+        ].freeze)
 
-        # Register this action with its valid parts when the module is loaded.
-        #
-        # @since 6.1.1
         ParamsRegistry.register(:stats_parts, [
-            :docs,
-            :fielddata,
-            :filter_cache,
-            :flush,
-            :get,
-            :indexing,
-            :merge,
-            :metric,
-            :refresh,
-            :search,
-            :suggest,
-            :store,
-            :warmer ].freeze)
+          :_all,
+          :completion,
+          :docs,
+          :fielddata,
+          :query_cache,
+          :flush,
+          :get,
+          :indexing,
+          :merge,
+          :request_cache,
+          :refresh,
+          :search,
+          :segments,
+          :store,
+          :warmer,
+          :suggest,
+          :metric
+        ].freeze)
+end
       end
-    end
   end
 end