elasticsearch-api 7.11.1 → 7.12.0

data/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb

@@ -27,7 +27,7 @@ module Elasticsearch
         # @option arguments [Time] :master_timeout Specify timeout for connection to master
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/modules-gateway-dangling-indices.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/modules-gateway-dangling-indices.html
         #
         def import_dangling_index(arguments = {})
           raise ArgumentError, "Required argument 'index_uuid' missing" unless arguments[:index_uuid]

data/lib/elasticsearch/api/actions/dangling_indices/list_dangling_indices.rb

@@ -23,7 +23,7 @@ module Elasticsearch
         #
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/modules-gateway-dangling-indices.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/modules-gateway-dangling-indices.html
         #
         def list_dangling_indices(arguments = {})
           headers = arguments.delete(:headers) || {}

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

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

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

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

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

@@ -24,7 +24,7 @@ module Elasticsearch
       # @option arguments [Number] :requests_per_second The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. (*Required*)
       # @option arguments [Hash] :headers Custom HTTP headers
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/docs-delete-by-query.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/docs-delete-by-query.html
       #
       def delete_by_query_rethrottle(arguments = {})
         raise ArgumentError, "Required argument 'task_id' missing" unless arguments[:task_id]

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

@@ -25,7 +25,7 @@ module Elasticsearch
       # @option arguments [Time] :master_timeout Specify timeout for connection to master
       # @option arguments [Hash] :headers Custom HTTP headers
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/modules-scripting.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/modules-scripting.html
       #
       def delete_script(arguments = {})
         raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]

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

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

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

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

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

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

data/lib/elasticsearch/api/actions/features/get_features.rb

@@ -0,0 +1,51 @@
+# 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 Features
+      module Actions
+        # Returns a list of features which can be snapshotted in this cluster.
+        #
+        # @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/modules-snapshots.html
+        #
+        def get_features(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = "_features"
+          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(:get_features, [
+          :master_timeout
+        ].freeze)
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/features/params_registry.rb

@@ -0,0 +1,60 @@
+# 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 Features
+      module Actions
+        module ParamsRegistry
+          extend self
+
+          # A Mapping of all the actions to their list of valid params.
+          #
+          # @since 6.1.1
+          PARAMS = {}
+
+          # Register an action with its list of valid params.
+          #
+          # @example Register the action.
+          #   ParamsRegistry.register(:benchmark, [ :verbose ])
+          #
+          # @param [ Symbol ] action The action to register.
+          # @param [ Array[Symbol] ] valid_params The list of valid params.
+          #
+          # @since 6.1.1
+          def register(action, valid_params)
+            PARAMS[action.to_sym] = valid_params
+          end
+
+          # Get the list of valid params for a given action.
+          #
+          # @example Get the list of valid params.
+          #   ParamsRegistry.get(:benchmark)
+          #
+          # @param [ Symbol ] action The action.
+          #
+          # @return [ Array<Symbol> ] The list of valid params for the action.
+          #
+          # @since 6.1.1
+          def get(action)
+            PARAMS.fetch(action, [])
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -29,7 +29,7 @@ module Elasticsearch
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body An index filter specified with the Query DSL
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/search-field-caps.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/search-field-caps.html
       #
       def field_caps(arguments = {})
         headers = arguments.delete(:headers) || {}

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

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

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

@@ -24,7 +24,7 @@ module Elasticsearch
       # @option arguments [Time] :master_timeout Specify timeout for connection to master
       # @option arguments [Hash] :headers Custom HTTP headers
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/modules-scripting.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/modules-scripting.html
       #
       def get_script(arguments = {})
         raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]

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

@@ -26,7 +26,7 @@ module Elasticsearch
       #
       # @option arguments [Hash] :headers Custom HTTP headers
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/painless/7.11/painless-contexts.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/painless/7.12/painless-contexts.html
       #
       def get_script_context(arguments = {})
         headers = arguments.delete(:headers) || {}

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

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

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

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

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

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

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

@@ -30,7 +30,7 @@ module Elasticsearch
         # @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.11/index-modules-blocks.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/index-modules-blocks.html
         #
         def add_block(arguments = {})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

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

@@ -25,7 +25,7 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body Define analyzer/tokenizer parameters and the text on which the analysis should be performed
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/indices-analyze.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/indices-analyze.html
         #
         def analyze(arguments = {})
           headers = arguments.delete(:headers) || {}

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

@@ -31,7 +31,7 @@ module Elasticsearch
         # @option arguments [Boolean] :request Clear request cache
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/indices-clearcache.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/indices-clearcache.html
         #
         def clear_cache(arguments = {})
           headers = arguments.delete(:headers) || {}

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

@@ -29,7 +29,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.11/indices-clone-index.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/indices-clone-index.html
         #
         def clone(arguments = {})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

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

@@ -27,10 +27,10 @@ module Elasticsearch
         # @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 [String] :wait_for_active_shards Sets the number of active shards to wait for before the operation returns. Set to `index-setting` to wait according to the index setting `index.write.wait_for_active_shards`, or `all` to wait for all shards, or an integer. Defaults to `0`.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/indices-open-close.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/indices-open-close.html
         #
         def close(arguments = {})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

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

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

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

@@ -29,7 +29,7 @@ module Elasticsearch
         # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/indices-delete-index.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/indices-delete-index.html
         #
         def delete(arguments = {})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

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

@@ -27,7 +27,7 @@ module Elasticsearch
         # @option arguments [Time] :master_timeout Specify timeout for connection to master
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/indices-aliases.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/indices-aliases.html
         #
         def delete_alias(arguments = {})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

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

@@ -26,7 +26,7 @@ module Elasticsearch
         # @option arguments [Time] :master_timeout Specify timeout for connection to master
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/indices-templates.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/indices-templates.html
         #
         def delete_index_template(arguments = {})
           raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

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

@@ -26,7 +26,7 @@ module Elasticsearch
         # @option arguments [Time] :master_timeout Specify timeout for connection to master
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/indices-templates.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/indices-templates.html
         #
         def delete_template(arguments = {})
           raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

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

@@ -30,7 +30,7 @@ module Elasticsearch
         # @option arguments [Boolean] :include_defaults Whether to return all default setting for each of the indices.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/indices-exists.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/indices-exists.html
         #
         def exists(arguments = {})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

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

@@ -29,7 +29,7 @@ module Elasticsearch
         # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/indices-aliases.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/indices-aliases.html
         #
         def exists_alias(arguments = {})
           raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

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

@@ -27,7 +27,7 @@ module Elasticsearch
         # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/indices-templates.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/indices-templates.html
         #
         def exists_index_template(arguments = {})
           raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

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

@@ -27,7 +27,7 @@ module Elasticsearch
         # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/indices-templates.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/indices-templates.html
         #
         def exists_template(arguments = {})
           raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

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

@@ -29,7 +29,7 @@ module Elasticsearch
         # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/indices-types-exists.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/indices-types-exists.html
         #
         def exists_type(arguments = {})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

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

@@ -29,7 +29,7 @@ module Elasticsearch
         # @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.11/indices-flush.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/indices-flush.html
         #
         def flush(arguments = {})
           headers = arguments.delete(:headers) || {}

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

@@ -32,7 +32,7 @@ module Elasticsearch
         # Deprecated since version 7.6.0
         #
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/indices-synced-flush-api.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/indices-synced-flush-api.html
         #
         def flush_synced(arguments = {})
           headers = arguments.delete(:headers) || {}