elasticsearch-api 6.2.0 → 6.3.0

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

@@ -9,11 +9,12 @@ module Elasticsearch
         # @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 [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.
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-split-index.html
+        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-split-index.html
         #
         def split(arguments={})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

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

@@ -25,10 +25,11 @@ module Elasticsearch
         #       ]
         #     }
         #
-        # @option arguments [Hash] :body The operations definition and other configuration (*Required*)
-        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [Hash] :body The definition of `actions` to perform (*Required*)
+        # @option arguments [Time] :timeout Request timeout
+        # @option arguments [Time] :master_timeout Specify timeout for connection to master
         #
-        # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/
+        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html
         #
         def update_aliases(arguments={})
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -44,7 +45,9 @@ module Elasticsearch
         # Register this action with its valid params when the module is loaded.
         #
         # @since 6.2.0
-        ParamsRegistry.register(:update_aliases, [ :timeout ].freeze)
+        ParamsRegistry.register(:update_aliases, [
+            :timeout,
+            :master_timeout ].freeze)
       end
     end
   end

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

@@ -5,18 +5,14 @@ module Elasticsearch
 
         # Upgrade the index or indices to the latest Lucene format.
         #
-        # @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.
-        # @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] :wait_for_completion Specify whether the request should block until the all
-        #                                                  segments are upgraded (default: true)
+        # @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] :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 [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
+        # @option arguments [Boolean] :wait_for_completion Specify whether the request should block until the all segments are upgraded (default: false)
+        # @option arguments [Boolean] :only_ancient_segments If true, only ancient (an older Lucene major release) segments will be upgraded
         #
-        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-upgrade.html
+        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-upgrade.html
         #
         def upgrade(arguments={})
           method = HTTP_POST
@@ -31,10 +27,11 @@ module Elasticsearch
         #
         # @since 6.2.0
         ParamsRegistry.register(:upgrade, [
-            :ignore_unavailable,
             :allow_no_indices,
             :expand_wildcards,
-            :wait_for_completion ].freeze)
+            :ignore_unavailable,
+            :wait_for_completion,
+            :only_ancient_segments ].freeze)
       end
     end
   end

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

@@ -37,33 +37,23 @@ module Elasticsearch
         #                                     }
         #                                   }
         #
-        # @option arguments [List] :index A comma-separated list of index names to restrict the operation;
-        #                                 use `_all` or empty string to perform the operation on all indices
-        # @option arguments [List] :type A comma-separated list of document types to restrict the operation;
-        #                                leave empty to perform the operation on all types
+        # @option arguments [List] :index A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
+        # @option arguments [List] :type A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types
         # @option arguments [Hash] :body The query definition specified with the Query DSL
         # @option arguments [Boolean] :explain Return detailed information about the error
-        # @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.
-        # @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] :operation_threading TODO: ?
+        # @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] :q Query in the Lucene query string syntax
         # @option arguments [String] :analyzer The analyzer to use for the query string
-        # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be
-        #                                               analyzed (default: false)
-        # @option arguments [String] :default_operator The default operator for query string query (AND or OR)
-        #                                              (options: AND, OR)
-        # @option arguments [String] :df The field to use as default where no field prefix is given in
-        #                                the query string
-        # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing
-        #                                      text to a numeric field) should be ignored
-        # @option arguments [Boolean] :lowercase_expanded_terms Specify whether query terms should be lowercased
+        # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
+        # @option arguments [String] :default_operator The default operator for query string query (AND or OR) (options: AND, OR)
+        # @option arguments [String] :df The field to use as default where no field prefix is given in the query string
+        # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
+        # @option arguments [Boolean] :rewrite Provide a more detailed explanation showing the actual Lucene query that will be executed.
+        # @option arguments [Boolean] :all_shards Execute validation on all shards instead of one random shard per index
         #
-        # @see http://www.elasticsearch.org/guide/reference/api/validate/
+        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/search-validate.html
         #
         def validate_query(arguments={})
           method = HTTP_GET
@@ -81,19 +71,18 @@ module Elasticsearch
         #
         # @since 6.2.0
         ParamsRegistry.register(:validate_query, [
-            :rewrite,
             :explain,
             :ignore_unavailable,
             :allow_no_indices,
             :expand_wildcards,
-            :operation_threading,
             :q,
             :analyzer,
             :analyze_wildcard,
             :default_operator,
             :df,
             :lenient,
-            :lowercase_expanded_terms ].freeze)
+            :rewrite,
+            :all_shards ].freeze)
       end
     end
   end

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

@@ -14,6 +14,12 @@ module Elasticsearch
 
         perform_request(method, path, params, body).body
       end
+
+      # Register this action with its valid params when the module is loaded.
+      #
+      # @since 6.2.0
+      ParamsRegistry.register(:info, [
+      ].freeze)
     end
   end
 end

data/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb

@@ -9,7 +9,7 @@ module Elasticsearch
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         # @option arguments [Time] :timeout Explicit operation timeout
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/plugins/current/ingest.html
         #
         def delete_pipeline(arguments={})
           raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]

data/lib/elasticsearch/api/actions/ingest/get_pipeline.rb

@@ -5,10 +5,10 @@ module Elasticsearch
 
         # Return a specified pipeline
         #
-        # @option arguments [String] :id Comma separated list of pipeline ids (wildcards supported).
+        # @option arguments [String] :id Comma separated list of pipeline ids. Wildcards supported
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/plugins/current/ingest.html
         #
         def get_pipeline(arguments={})
           method = 'GET'
@@ -22,7 +22,8 @@ module Elasticsearch
         # Register this action with its valid params when the module is loaded.
         #
         # @since 6.2.0
-        ParamsRegistry.register(:get_pipeline, [ :master_timeout ].freeze)
+        ParamsRegistry.register(:get_pipeline, [
+            :master_timeout ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/ingest/processor_grok.rb

@@ -0,0 +1,29 @@
+module Elasticsearch
+  module API
+    module Ingest
+      module Actions
+
+        # Extracts structured fields out of a single text field within a document. You choose which field to extract
+        #   matched fields from, as well as the grok pattern you expect will match.
+        #
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/plugins/current/ingest.html
+        #
+        def processor_grok(arguments={})
+          method = Elasticsearch::API::HTTP_GET
+          path   = "_ingest/processor/grok"
+          params = {}
+          body   = nil
+
+          perform_request(method, path, params, body).body
+        end
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.2.0
+        ParamsRegistry.register(:processor_grok, [
+        ].freeze)
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/ingest/put_pipeline.rb

@@ -10,7 +10,7 @@ module Elasticsearch
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         # @option arguments [Time] :timeout Explicit operation timeout
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/plugins/current/ingest.html
         #
         def put_pipeline(arguments={})
           raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]

data/lib/elasticsearch/api/actions/ingest/simulate.rb

@@ -6,11 +6,10 @@ module Elasticsearch
         # Execute a specific pipeline against the set of documents provided in the body of the request
         #
         # @option arguments [String] :id Pipeline ID
-        # @option arguments [Hash] :body The pipeline definition (*Required*)
-        # @option arguments [Boolean] :verbose Verbose mode. Display data output for each processor
-        #                                                    in executed pipeline
+        # @option arguments [Hash] :body The simulate definition (*Required*)
+        # @option arguments [Boolean] :verbose Verbose mode. Display data output for each processor in executed pipeline
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/plugins/current/ingest.html
         #
         def simulate(arguments={})
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -25,7 +24,8 @@ module Elasticsearch
         # Register this action with its valid params when the module is loaded.
         #
         # @since 6.2.0
-        ParamsRegistry.register(:simulate, [ :verbose ].freeze)
+        ParamsRegistry.register(:simulate, [
+            :verbose ].freeze)
       end
     end
   end

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

@@ -27,20 +27,15 @@ module Elasticsearch
       #
       # @option arguments [String] :index The name of the index
       # @option arguments [String] :type The type of the document
-      # @option arguments [Hash] :body Document identifiers; can be either `docs` (containing full document information)
-      #                                or `ids` (when index and type is provided in the URL (*Required*)
-      # @option arguments [List] :fields A comma-separated list of fields to return in the response
-      # @option arguments [String] :parent The ID of the parent document
-      # @option arguments [String] :preference Specify the node or shard the operation should be performed on
-      #                                        (default: random)
+      # @option arguments [Hash] :body Document identifiers; can be either `docs` (containing full document information) or `ids` (when index and type is provided in the URL. (*Required*)
+      # @option arguments [List] :stored_fields A comma-separated list of stored fields to return in the response
+      # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
       # @option arguments [Boolean] :realtime Specify whether to perform the operation in realtime or search mode
       # @option arguments [Boolean] :refresh Refresh the shard containing the document before performing the operation
       # @option arguments [String] :routing Specific routing value
-      # @option arguments [String] :_source Specify whether the _source field should be returned,
-      #                                     or a list of fields to return
-      # @option arguments [String] :_source_exclude A list of fields to exclude from the returned _source field
-      # @option arguments [String] :_source_include A list of fields to extract and return from the _source field
-      # @option arguments [List] :stored_fields A comma-separated list of stored fields to return in the response
+      # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return
+      # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field
+      # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field
       #
       # @see http://elasticsearch.org/guide/reference/api/multi-get/
       #
@@ -63,18 +58,14 @@ module Elasticsearch
       #
       # @since 6.2.0
       ParamsRegistry.register(:mget, [
-          :fields,
-          :parent,
+          :stored_fields,
           :preference,
           :realtime,
           :refresh,
           :routing,
           :_source,
-          :_source_include,
-          :_source_includes,
-          :_source_exclude,
           :_source_excludes,
-          :stored_fields ].freeze)
+          :_source_includes ].freeze)
     end
   end
 end

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

@@ -28,10 +28,13 @@ module Elasticsearch
       #
       # @option arguments [List] :index A comma-separated list of index names to use as default
       # @option arguments [List] :type A comma-separated list of document types to use as default
-      # @option arguments [Hash] :body The request definitions (metadata-search request definition pairs)
+      # @option arguments [Hash] :body The request definitions (metadata-search request definition pairs), separated by newlines (*Required*)
       # @option arguments [String] :search_type Search operation type (options: query_then_fetch, query_and_fetch, dfs_query_then_fetch, dfs_query_and_fetch)
       # @option arguments [Number] :max_concurrent_searches Controls the maximum number of concurrent searches the multi search api will execute
       # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
+      # @option arguments [Number] :pre_filter_shard_size A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on it's rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.
+      # @option arguments [Number] :max_concurrent_shard_requests The number of concurrent shard requests each sub search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
+      # @option arguments [Boolean] :rest_total_hits_as_int This parameter is ignored in this version. It is used in the next major version to control whether the rest response should render the total.hits as an object or a number
       #
       # @see https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-multi-search.html
       #
@@ -68,14 +71,16 @@ module Elasticsearch
         perform_request(method, path, params, payload, {"Content-Type" => "application/x-ndjson"}).body
       end
 
+
       # Register this action with its valid params when the module is loaded.
       #
       # @since 6.2.0
       ParamsRegistry.register(:msearch, [
           :search_type,
           :max_concurrent_searches,
-          :max_concurrent_shard_requests,
           :typed_keys,
+          :pre_filter_shard_size,
+          :max_concurrent_shard_requests,
           :rest_total_hits_as_int ].freeze)
     end
   end

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

@@ -15,6 +15,9 @@ module Elasticsearch
       # @option arguments [List] :type A comma-separated list of document types to use as default
       # @option arguments [Hash] :body The request definitions (metadata-search request definition pairs), separated by newlines (*Required*)
       # @option arguments [String] :search_type Search operation type (options: query_then_fetch, query_and_fetch, dfs_query_then_fetch, dfs_query_and_fetch)
+      # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
+      # @option arguments [Number] :max_concurrent_searches Controls the maximum number of concurrent searches the multi search api will execute
+      # @option arguments [Boolean] :rest_total_hits_as_int This parameter is ignored in this version. It is used in the next major version to control whether the rest response should render the total.hits as an object or a number
       #
       # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/multi-search-template.html
       #
@@ -42,7 +45,11 @@ module Elasticsearch
       # Register this action with its valid params when the module is loaded.
       #
       # @since 6.2.0
-      ParamsRegistry.register(:msearch_template, [ :search_type ].freeze)
+      ParamsRegistry.register(:msearch_template, [
+          :search_type,
+          :typed_keys,
+          :max_concurrent_searches,
+          :rest_total_hits_as_int ].freeze)
     end
   end
 end

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

@@ -9,27 +9,24 @@ module Elasticsearch
       #
       #     subject.mtermvectors index: 'my-index', type: 'my-type', body: { ids: [1, 2, 3] }
       #
-      # @option arguments [String] :index The name of the index
-      # @option arguments [String] :type The type of the document
-      # @option arguments [Hash] :body Document identifiers; can be either `docs` (containing full document information)
-      #                                or `ids` (when index and type is provided in the URL (*Required*)
-      # @option arguments [List] :ids A comma-separated list of documents ids (alternative to `:body`)
-      # @option arguments [Boolean] :term_statistics Whether total term frequency and
-      #                                              document frequency should be returned.
-      # @option arguments [Boolean] :field_statistics Whether document count, sum of document frequencies
-      #                                               and sum of total term frequencies should be returned.
-      # @option arguments [List] :fields A comma-separated list of fields to return
-      # @option arguments [Boolean] :offsets Whether term offsets should be returned
-      # @option arguments [Boolean] :positions Whether term positions should be returned
-      # @option arguments [Boolean] :payloads Whether term payloads should be returned
-      # @option arguments [String] :preference Specify the node or shard the operation should be performed on
-      #                                        (default: random)
-      # @option arguments [String] :realtime Specifies if requests are real-time as opposed to near-real-time
-      #                                      (default: true)
-      # @option arguments [String] :routing Specific routing value
-      # @option arguments [String] :parent Parent ID of documents
+      # @option arguments [String] :index The index in which the document resides.
+      # @option arguments [String] :type The type of the document.
+      # @option arguments [Hash] :body Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation.
+      # @option arguments [List] :ids A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body
+      # @option arguments [Boolean] :term_statistics Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".
+      # @option arguments [Boolean] :field_statistics Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".
+      # @option arguments [List] :fields A comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body "params" or "docs".
+      # @option arguments [Boolean] :offsets Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".
+      # @option arguments [Boolean] :positions Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".
+      # @option arguments [Boolean] :payloads Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".
+      # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) .Applies to all returned documents unless otherwise specified in body "params" or "docs".
+      # @option arguments [String] :routing Specific routing value. Applies to all returned documents unless otherwise specified in body "params" or "docs".
+      # @option arguments [String] :parent Parent id of documents. Applies to all returned documents unless otherwise specified in body "params" or "docs".
+      # @option arguments [Boolean] :realtime Specifies if requests are real-time as opposed to near-real-time (default: true).
+      # @option arguments [Number] :version Explicit version number for concurrency control
+      # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte, force)
       #
-      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html
+      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-multi-termvectors.html
       #
       # @see #mget
       # @see #termvector
@@ -65,9 +62,11 @@ module Elasticsearch
           :positions,
           :payloads,
           :preference,
-          :realtime,
           :routing,
-          :parent ].freeze)
+          :parent,
+          :realtime,
+          :version,
+          :version_type ].freeze)
     end
   end
 end

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

@@ -13,18 +13,15 @@ module Elasticsearch
         #
         #     client.nodes.hot_threads threads: 10
         #
-        # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information;
-        #                                   use `_local` to return information from the node you're connecting to,
-        #                                   leave empty to get information from all nodes
+        # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
         # @option arguments [Time] :interval The interval for the second sampling of threads
         # @option arguments [Number] :snapshots Number of samples of thread stacktrace (default: 10)
         # @option arguments [Number] :threads Specify the number of threads to provide information for (default: 3)
+        # @option arguments [Boolean] :ignore_idle_threads Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue (default: true)
         # @option arguments [String] :type The type to sample (default: cpu) (options: cpu, wait, block)
         # @option arguments [Time] :timeout Explicit operation timeout
         #
-        # @return [String]
-        #
-        # @see http://www.elasticsearch.org/guide/reference/api/admin-cluster-nodes-hot-threads/
+        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-hot-threads.html
         #
         def hot_threads(arguments={})
           method = HTTP_GET
@@ -43,6 +40,7 @@ module Elasticsearch
             :interval,
             :snapshots,
             :threads,
+            :ignore_idle_threads,
             :type,
             :timeout ].freeze)
       end