elasticsearch-api 7.12.0 → 7.13.0.pre

data/lib/elasticsearch/api/actions/reindex_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.12/docs-reindex.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/docs-reindex.html
       #
       def reindex_rethrottle(arguments = {})
         raise ArgumentError, "Required argument 'task_id' missing" unless arguments[:task_id]

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

@@ -24,7 +24,7 @@ module Elasticsearch
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body The search definition template and its params
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/search-template.html#_validating_templates
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/search-template.html#_validating_templates
       #
       def render_search_template(arguments = {})
         headers = arguments.delete(:headers) || {}

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

@@ -27,7 +27,7 @@ module Elasticsearch
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body The script to execute
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/painless/7.12/painless-execute-api.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/painless/7.x/painless-execute-api.html
       #
       def scripts_painless_execute(arguments = {})
         headers = arguments.delete(:headers) || {}

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

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

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

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

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

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

data/lib/elasticsearch/api/actions/shutdown/delete_node.rb

@@ -0,0 +1,52 @@
+# 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 Shutdown
+      module Actions
+        # Removes a node from the shutdown list
+        # 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 [String] :node_id The node id of node to be removed from the shutdown state
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current
+        #
+        def delete_node(arguments = {})
+          raise ArgumentError, "Required argument 'node_id' missing" unless arguments[:node_id]
+
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _node_id = arguments.delete(:node_id)
+
+          method = Elasticsearch::API::HTTP_DELETE
+          path   = "_nodes/#{Utils.__listify(_node_id)}/shutdown"
+          params = {}
+
+          body = nil
+          perform_request(method, path, params, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/shutdown/get_node.rb

@@ -0,0 +1,54 @@
+# 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 Shutdown
+      module Actions
+        # Retrieve status of a node or nodes that are currently marked as shutting down
+        # 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 [String] :node_id Which node for which to retrieve the shutdown status
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current
+        #
+        def get_node(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _node_id = arguments.delete(:node_id)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _node_id
+                     "_nodes/#{Utils.__listify(_node_id)}/shutdown"
+                   else
+                     "_nodes/shutdown"
+                   end
+          params = {}
+
+          body = nil
+          perform_request(method, path, params, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/shutdown/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 Shutdown
+      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/shutdown/put_node.rb

@@ -0,0 +1,54 @@
+# 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 Shutdown
+      module Actions
+        # Adds a node to be shut down
+        # 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 [String] :node_id The node id of node to be shut down
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The shutdown type definition to register (*Required*)
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current
+        #
+        def put_node(arguments = {})
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+          raise ArgumentError, "Required argument 'node_id' missing" unless arguments[:node_id]
+
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _node_id = arguments.delete(:node_id)
+
+          method = Elasticsearch::API::HTTP_PUT
+          path   = "_nodes/#{Utils.__listify(_node_id)}/shutdown"
+          params = {}
+
+          body = arguments[:body]
+          perform_request(method, path, params, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/snapshot/cleanup_repository.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/clean-up-snapshot-repo-api.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/clean-up-snapshot-repo-api.html
         #
         def cleanup_repository(arguments = {})
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]

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

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

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

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

data/lib/elasticsearch/api/actions/snapshot/create_repository.rb

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

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

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

data/lib/elasticsearch/api/actions/snapshot/delete_repository.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/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/modules-snapshots.html
         #
         def delete_repository(arguments = {})
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]

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

@@ -25,10 +25,11 @@ module Elasticsearch
         # @option arguments [List] :snapshot A comma-separated list of snapshot names
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         # @option arguments [Boolean] :ignore_unavailable Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown
+        # @option arguments [Boolean] :index_details Whether to include details of each index in the snapshot, if those details are available. Defaults to false.
         # @option arguments [Boolean] :verbose Whether to show verbose snapshot info or only show the basic info found in the repository index blob
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/modules-snapshots.html
         #
         def get(arguments = {})
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
@@ -60,6 +61,7 @@ module Elasticsearch
         ParamsRegistry.register(:get, [
           :master_timeout,
           :ignore_unavailable,
+          :index_details,
           :verbose
         ].freeze)
       end

data/lib/elasticsearch/api/actions/snapshot/get_repository.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.12/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/modules-snapshots.html
         #
         def get_repository(arguments = {})
           headers = arguments.delete(:headers) || {}

data/lib/elasticsearch/api/actions/snapshot/restore.rb

@@ -28,7 +28,7 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body Details of what to restore
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/modules-snapshots.html
         #
         def restore(arguments = {})
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]

data/lib/elasticsearch/api/actions/snapshot/status.rb

@@ -27,7 +27,7 @@ module Elasticsearch
         # @option arguments [Boolean] :ignore_unavailable Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/modules-snapshots.html
         #
         def status(arguments = {})
           headers = arguments.delete(:headers) || {}

data/lib/elasticsearch/api/actions/snapshot/verify_repository.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/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/modules-snapshots.html
         #
         def verify_repository(arguments = {})
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]

data/lib/elasticsearch/api/actions/tasks/cancel.rb

@@ -32,7 +32,7 @@ module Elasticsearch
         # @option arguments [Boolean] :wait_for_completion Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/tasks.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/tasks.html
         #
         def cancel(arguments = {})
           headers = arguments.delete(:headers) || {}

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

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

data/lib/elasticsearch/api/actions/tasks/list.rb

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