elasticsearch-api 7.12.0 → 7.13.0.pre

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

@@ -30,7 +30,7 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body The configuration for the target index (`settings` and `aliases`)
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/indices-split-index.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-split-index.html
         #
         def split(arguments = {})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

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

@@ -35,7 +35,7 @@ module Elasticsearch
         # @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
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/indices-stats.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-stats.html
         #
         def stats(arguments = {})
           headers = arguments.delete(:headers) || {}

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

@@ -19,37 +19,47 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-        # In order to keep indices available and queryable for a longer period but at the same time reduce their
-        #   hardware requirements they can be transitioned into a frozen state. Once an index is frozen, all of its
-        #   transient shard memory (aside from mappings and analyzers) is moved to persistent storage.
+        # Unfreezes an index. When a frozen index is unfrozen, the index goes through the normal recovery process and becomes writeable again.
         #
-        # @option arguments [List] :index A comma separated list of indices to unfreeze. (*Required*)
+        # @option arguments [String] :index The name of the index to unfreeze
+        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [Time] :master_timeout Specify timeout for connection to master
+        # @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, hidden, none, all)
+        # @option arguments [String] :wait_for_active_shards Sets the number of active shards to wait for before the operation returns.
+        # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @note This feature is available in the Platinum distribution of Elasticsearch.
-        #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/frozen-indices.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/unfreeze-index-api.html
         #
         def unfreeze(arguments = {})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
 
-          valid_params = [
-            :timeout,
-            :master_timeout,
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards,
-            :wait_for_active_shards
-          ]
+          headers = arguments.delete(:headers) || {}
 
           arguments = arguments.clone
-          index = arguments.delete(:index)
+
+          _index = arguments.delete(:index)
 
           method = Elasticsearch::API::HTTP_POST
-          path = Elasticsearch::API::Utils.__pathify Elasticsearch::API::Utils.__listify(index), '_unfreeze'
-          params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
+          path   = "#{Utils.__listify(_index)}/_unfreeze"
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
-          perform_request(method, path, params).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(:unfreeze, [
+          :timeout,
+          :master_timeout,
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards,
+          :wait_for_active_shards
+        ].freeze)
       end
     end
   end

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

@@ -26,7 +26,7 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body The definition of `actions` to perform (*Required*)
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/indices-aliases.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-aliases.html
         #
         def update_aliases(arguments = {})
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

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

@@ -34,7 +34,7 @@ module Elasticsearch
         # Deprecated since version 8.0.0
         #
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/indices-upgrade.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-upgrade.html
         #
         def upgrade(arguments = {})
           headers = arguments.delete(:headers) || {}

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

@@ -43,7 +43,7 @@ module Elasticsearch
         # Deprecated since version 7.0.0
         #
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/search-validate.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/search-validate.html
         #
         def validate_query(arguments = {})
           headers = arguments.delete(:headers) || {}

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

@@ -22,7 +22,7 @@ module Elasticsearch
       #
       # @option arguments [Hash] :headers Custom HTTP headers
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/index.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/index.html
       #
       def info(arguments = {})
         headers = arguments.delete(:headers) || {}

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

@@ -26,7 +26,7 @@ module Elasticsearch
         # @option arguments [Time] :timeout Explicit operation timeout
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/delete-pipeline-api.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/delete-pipeline-api.html
         #
         def delete_pipeline(arguments = {})
           raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]

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

@@ -0,0 +1,43 @@
+# 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 Ingest
+      module Actions
+        # Returns statistical information about geoip databases
+        #
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/geoip-stats-api.html
+        #
+        def geo_ip_stats(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = "_ingest/geoip/stats"
+          params = {}
+
+          body = nil
+          perform_request(method, path, params, body, headers).body
+        end
+      end
+    end
+  end
+end

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

@@ -22,10 +22,11 @@ module Elasticsearch
         # Returns a pipeline.
         #
         # @option arguments [String] :id Comma separated list of pipeline ids. Wildcards supported
+        # @option arguments [Boolean] :summary Return pipelines without their definitions (default: false)
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/get-pipeline-api.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/get-pipeline-api.html
         #
         def get_pipeline(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -50,6 +51,7 @@ module Elasticsearch
         #
         # @since 6.2.0
         ParamsRegistry.register(:get_pipeline, [
+          :summary,
           :master_timeout
         ].freeze)
       end

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

@@ -23,7 +23,7 @@ module Elasticsearch
         #
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/grok-processor.html#grok-processor-rest-get
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/grok-processor.html#grok-processor-rest-get
         #
         def processor_grok(arguments = {})
           headers = arguments.delete(:headers) || {}

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

@@ -27,7 +27,7 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body The ingest definition (*Required*)
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/put-pipeline-api.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/put-pipeline-api.html
         #
         def put_pipeline(arguments = {})
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

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

@@ -26,7 +26,7 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body The simulate definition (*Required*)
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/simulate-pipeline-api.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/simulate-pipeline-api.html
         #
         def simulate(arguments = {})
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

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

@@ -38,7 +38,7 @@ module Elasticsearch
       # Deprecated since version 7.0.0
       #
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/docs-multi-get.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/docs-multi-get.html
       #
       def mget(arguments = {})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

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

@@ -37,7 +37,7 @@ module Elasticsearch
       # Deprecated since version 7.0.0
       #
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/search-multi-search.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/search-multi-search.html
       #
       def msearch(arguments = {})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

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

@@ -35,7 +35,7 @@ module Elasticsearch
       # Deprecated since version 7.0.0
       #
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/search-multi-search.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/search-multi-search.html
       #
       def msearch_template(arguments = {})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

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

@@ -42,7 +42,7 @@ module Elasticsearch
       # Deprecated since version 7.0.0
       #
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/docs-multi-termvectors.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/docs-multi-termvectors.html
       #
       def mtermvectors(arguments = {})
         headers = arguments.delete(:headers) || {}

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

@@ -35,7 +35,7 @@ module Elasticsearch
         # Deprecated since version 7.0.0
         #
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/cluster-nodes-hot-threads.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cluster-nodes-hot-threads.html
         #
         def hot_threads(arguments = {})
           headers = arguments.delete(:headers) || {}

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

@@ -27,7 +27,7 @@ module Elasticsearch
         # @option arguments [Time] :timeout Explicit operation timeout
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/cluster-nodes-info.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cluster-nodes-info.html
         #
         def info(arguments = {})
           headers = arguments.delete(:headers) || {}

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

@@ -26,7 +26,7 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body An object containing the password for the elasticsearch keystore
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/secure-settings.html#reloadable-secure-settings
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/secure-settings.html#reloadable-secure-settings
         #
         def reload_secure_settings(arguments = {})
           headers = arguments.delete(:headers) || {}

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

@@ -32,9 +32,10 @@ module Elasticsearch
         # @option arguments [List] :types A comma-separated list of document types for the `indexing` index metric
         # @option arguments [Time] :timeout Explicit operation timeout
         # @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 [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/cluster-nodes-stats.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cluster-nodes-stats.html
         #
         def stats(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -78,7 +79,8 @@ module Elasticsearch
           :level,
           :types,
           :timeout,
-          :include_segment_file_sizes
+          :include_segment_file_sizes,
+          :include_unloaded_segments
         ].freeze)
       end
     end

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

@@ -26,7 +26,7 @@ module Elasticsearch
         # @option arguments [Time] :timeout Explicit operation timeout
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/cluster-nodes-usage.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cluster-nodes-usage.html
         #
         def usage(arguments = {})
           headers = arguments.delete(:headers) || {}

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

@@ -0,0 +1,64 @@
+# 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 Actions
+      # Open a point in time that can be used in subsequent searches
+      #
+      # @option arguments [List] :index A comma-separated list of index names to open point in time; use `_all` or empty string to perform the operation on all indices
+      # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
+      # @option arguments [String] :routing Specific routing value
+      # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
+      # @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 [String] :keep_alive Specific the time to live for the point in time
+      # @option arguments [Hash] :headers Custom HTTP headers
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/point-in-time-api.html
+      #
+      def open_point_in_time(arguments = {})
+        headers = arguments.delete(:headers) || {}
+
+        arguments = arguments.clone
+
+        _index = arguments.delete(:index)
+
+        method = Elasticsearch::API::HTTP_POST
+        path   = if _index
+                   "#{Utils.__listify(_index)}/_pit"
+                 else
+                   "_pit"
+                 end
+        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+
+        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(:open_point_in_time, [
+        :preference,
+        :routing,
+        :ignore_unavailable,
+        :expand_wildcards,
+        :keep_alive
+      ].freeze)
+    end
+  end
+end

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

@@ -22,7 +22,7 @@ module Elasticsearch
       #
       # @option arguments [Hash] :headers Custom HTTP headers
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/index.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/index.html
       #
       def ping(arguments = {})
         headers = arguments.delete(:headers) || {}

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

@@ -27,7 +27,7 @@ module Elasticsearch
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body The document (*Required*)
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/modules-scripting.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/modules-scripting.html
       #
       def put_script(arguments = {})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

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

@@ -32,7 +32,7 @@ module Elasticsearch
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body The ranking evaluation search definition, including search requests, document ratings and ranking metric definition. (*Required*)
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/search-rank-eval.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/search-rank-eval.html
       #
       def rank_eval(arguments = {})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

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

@@ -33,7 +33,7 @@ module Elasticsearch
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body The search definition using the Query DSL and the prototype for the index request. (*Required*)
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/docs-reindex.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/docs-reindex.html
       #
       def reindex(arguments = {})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]