elasticsearch-api 7.11.0 → 7.13.0

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

@@ -0,0 +1,42 @@
+# 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
+      # Close a point in time
+      #
+      # @option arguments [Hash] :headers Custom HTTP headers
+      # @option arguments [Hash] :body a point-in-time id to close
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/point-in-time-api.html
+      #
+      def close_point_in_time(arguments = {})
+        headers = arguments.delete(:headers) || {}
+
+        arguments = arguments.clone
+
+        method = Elasticsearch::API::HTTP_DELETE
+        path   = "_pit"
+        params = {}
+
+        body = arguments[:body]
+        perform_request(method, path, params, body, headers).body
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/cluster/allocation_explain.rb

@@ -26,7 +26,7 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body The index, shard, and primary flag to explain. Empty means 'explain the first unassigned shard'
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/cluster-allocation-explain.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/cluster-allocation-explain.html
         #
         def allocation_explain(arguments = {})
           headers = arguments.delete(:headers) || {}

data/lib/elasticsearch/api/actions/cluster/delete_component_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-component-template.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-component-template.html
         #
         def delete_component_template(arguments = {})
           raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

data/lib/elasticsearch/api/actions/cluster/delete_voting_config_exclusions.rb

@@ -24,7 +24,7 @@ module Elasticsearch
         # @option arguments [Boolean] :wait_for_removal Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions list.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/voting-config-exclusions.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/voting-config-exclusions.html
         #
         def delete_voting_config_exclusions(arguments = {})
           headers = arguments.delete(:headers) || {}

data/lib/elasticsearch/api/actions/cluster/exists_component_template.rb

@@ -26,7 +26,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-component-template.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-component-template.html
         #
         def exists_component_template(arguments = {})
           raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

data/lib/elasticsearch/api/actions/cluster/get_component_template.rb

@@ -26,7 +26,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-component-template.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-component-template.html
         #
         def get_component_template(arguments = {})
           headers = arguments.delete(:headers) || {}

data/lib/elasticsearch/api/actions/cluster/get_settings.rb

@@ -27,7 +27,7 @@ module Elasticsearch
         # @option arguments [Boolean] :include_defaults Whether to return all default clusters setting.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/cluster-update-settings.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/cluster-get-settings.html
         #
         def get_settings(arguments = {})
           headers = arguments.delete(:headers) || {}

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

@@ -35,7 +35,7 @@ module Elasticsearch
         # @option arguments [String] :wait_for_status Wait until cluster is in a specific state (options: green, yellow, red)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/cluster-health.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/cluster-health.html
         #
         def health(arguments = {})
           headers = arguments.delete(:headers) || {}

data/lib/elasticsearch/api/actions/cluster/pending_tasks.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/cluster-pending.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/cluster-pending.html
         #
         def pending_tasks(arguments = {})
           headers = arguments.delete(:headers) || {}

data/lib/elasticsearch/api/actions/cluster/post_voting_config_exclusions.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.11/voting-config-exclusions.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/voting-config-exclusions.html
         #
         def post_voting_config_exclusions(arguments = {})
           headers = arguments.delete(:headers) || {}

data/lib/elasticsearch/api/actions/cluster/put_component_template.rb

@@ -28,7 +28,7 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body The template definition (*Required*)
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/indices-component-template.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-component-template.html
         #
         def put_component_template(arguments = {})
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

data/lib/elasticsearch/api/actions/cluster/put_settings.rb

@@ -27,7 +27,7 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body The settings to be updated. Can be either `transient` or `persistent` (survives cluster restart). (*Required*)
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/cluster-update-settings.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/cluster-update-settings.html
         #
         def put_settings(arguments = {})
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

data/lib/elasticsearch/api/actions/cluster/remote_info.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/cluster-remote-info.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/cluster-remote-info.html
         #
         def remote_info(arguments = {})
           headers = arguments.delete(:headers) || {}

data/lib/elasticsearch/api/actions/cluster/reroute.rb

@@ -30,7 +30,7 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body The definition of `commands` to perform (`move`, `cancel`, `allocate`)
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/cluster-reroute.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/cluster-reroute.html
         #
         def reroute(arguments = {})
           headers = arguments.delete(:headers) || {}

data/lib/elasticsearch/api/actions/cluster/state.rb

@@ -33,7 +33,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/cluster-state.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/cluster-state.html
         #
         def state(arguments = {})
           headers = arguments.delete(:headers) || {}

data/lib/elasticsearch/api/actions/cluster/stats.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.11/cluster-stats.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/cluster-stats.html
         #
         def stats(arguments = {})
           headers = arguments.delete(:headers) || {}

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

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

data/lib/elasticsearch/api/actions/create.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-index_.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/docs-index_.html
       #
       def create(arguments = {})
         if arguments[:id]

data/lib/elasticsearch/api/actions/dangling_indices/delete_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.13/modules-gateway-dangling-indices.html
         #
         def delete_dangling_index(arguments = {})
           raise ArgumentError, "Required argument 'index_uuid' missing" unless arguments[:index_uuid]

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.13/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.13/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.13/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.13/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.13/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.13/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.13/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.13/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.13/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
+        # Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot
+        #
+        # @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.13/get-features-api.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/features/reset_features.rb

@@ -0,0 +1,47 @@
+# 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
+        # Resets the internal state of features, usually by deleting system indices
+        # This functionality is Experimental and may be changed or removed
+        # completely in a future release. Elastic will take a best effort approach
+        # to fix any issues, but experimental features are not subject to the
+        # support SLA of official GA features.
+        #
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/modules-snapshots.html
+        #
+        def reset_features(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_features/_reset"
+          params = {}
+
+          body = nil
+          perform_request(method, path, params, body, headers).body
+        end
+      end
+    end
+  end
+end