elasticsearch-api 6.8.0 → 7.10.0

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

@@ -1,46 +1,56 @@
+# 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 Snapshot
       module Actions
-
-        # Return information about specific (or all) snapshots
-        #
-        # @example Return information about the `snapshot-2` snapshot
-        #
-        #     client.snapshot.get repository: 'my-backup', snapshot: 'snapshot-2'
-        #
-        # @example Return information about multiple snapshots
-        #
-        #     client.snapshot.get repository: 'my-backup', snapshot: ['snapshot-2', 'snapshot-3']
+        # Returns information about a snapshot.
         #
-        # @example Return information about all snapshots in the repository
-        #
-        #     client.snapshot.get repository: 'my-backup', snapshot: '_all'
-        #
-        # @option arguments [String] :repository A repository name (*Required*)
-        # @option arguments [List] :snapshot A comma-separated list of snapshot names (*Required*)
+        # @option arguments [String] :repository A repository name
+        # @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] :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 http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/modules-snapshots.html
         #
-        def get(arguments={})
+        def get(arguments = {})
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
-          raise ArgumentError, "Required argument 'snapshot' missing"   unless arguments[:snapshot]
-          repository = arguments.delete(:repository)
-          snapshot   = arguments.delete(:snapshot)
+          raise ArgumentError, "Required argument 'snapshot' missing" unless arguments[:snapshot]
+
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _repository = arguments.delete(:repository)
 
-          method = HTTP_GET
-          path   = Utils.__pathify( '_snapshot', Utils.__escape(repository), Utils.__listify(snapshot) )
+          _snapshot = arguments.delete(:snapshot)
 
+          method = Elasticsearch::API::HTTP_GET
+          path   = "_snapshot/#{Utils.__listify(_repository)}/#{Utils.__listify(_snapshot)}"
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
 
+          body = nil
           if Array(arguments[:ignore]).include?(404)
-            Utils.__rescue_from_not_found { perform_request(method, path, params, body).body }
+            Utils.__rescue_from_not_found { perform_request(method, path, params, body, headers).body }
           else
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
         end
 
@@ -48,9 +58,10 @@ module Elasticsearch
         #
         # @since 6.2.0
         ParamsRegistry.register(:get, [
-            :master_timeout,
-            :ignore_unavailable,
-            :verbose ].freeze)
+          :master_timeout,
+          :ignore_unavailable,
+          :verbose
+        ].freeze)
       end
     end
   end

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

@@ -1,36 +1,53 @@
+# 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 Snapshot
       module Actions
-
-        # Get information about snapshot repositories or a specific repository
-        #
-        # @example Get all repositories
-        #
-        #     client.snapshot.get_repository
-        #
-        # @example Get a specific repository
-        #
-        #     client.snapshot.get_repository repository: 'my-backups'
+        # Returns information about a repository.
         #
         # @option arguments [List] :repository A comma-separated list of repository names
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         # @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 http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/modules-snapshots.html
         #
-        def get_repository(arguments={})
-          repository = arguments.delete(:repository)
-          method = HTTP_GET
-          path   = Utils.__pathify( '_snapshot', Utils.__escape(repository) )
+        def get_repository(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _repository = arguments.delete(:repository)
 
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _repository
+                     "_snapshot/#{Utils.__listify(_repository)}"
+                   else
+                     "_snapshot"
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
 
+          body = nil
           if Array(arguments[:ignore]).include?(404)
-            Utils.__rescue_from_not_found { perform_request(method, path, params, body).body }
+            Utils.__rescue_from_not_found { perform_request(method, path, params, body, headers).body }
           else
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
         end
 
@@ -38,8 +55,9 @@ module Elasticsearch
         #
         # @since 6.2.0
         ParamsRegistry.register(:get_repository, [
-            :master_timeout,
-            :local ].freeze)
+          :master_timeout,
+          :local
+        ].freeze)
       end
     end
   end

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

@@ -1,14 +1,30 @@
+# 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 Snapshot
       module Actions
         module ParamsRegistry
-
           extend self
 
           # A Mapping of all the actions to their list of valid params.
           #
-          # @since 6.2.0
+          # @since 6.1.1
           PARAMS = {}
 
           # Register an action with its list of valid params.
@@ -19,7 +35,7 @@ module Elasticsearch
           # @param [ Symbol ] action The action to register.
           # @param [ Array[Symbol] ] valid_params The list of valid params.
           #
-          # @since 6.2.0
+          # @since 6.1.1
           def register(action, valid_params)
             PARAMS[action.to_sym] = valid_params
           end
@@ -33,7 +49,7 @@ module Elasticsearch
           #
           # @return [ Array<Symbol> ] The list of valid params for the action.
           #
-          # @since 6.2.0
+          # @since 6.1.1
           def get(action)
             PARAMS.fetch(action, [])
           end

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

@@ -1,54 +1,62 @@
+# 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 Snapshot
       module Actions
-
-        # Restore the state from a snapshot
-        #
-        # @example Restore from the `snapshot-1` snapshot
-        #
-        #     client.snapshot.restore repository: 'my-backups', snapshot: 'snapshot-1'
-        #
-        # @example Restore a specific index under a different name
-        #
-        #     client.snapshot.restore repository: 'my-backups',
-        #                             snapshot: 'snapshot-1',
-        #                             body: {
-        #                               rename_pattern: "^(.*)$",
-        #                               rename_replacement: "restored_$1"
-        #                             }
+        # Restores a snapshot.
         #
-        # @note You cannot restore into an open index, you have to {Indices::Actions#close} it first
-        #
-        # @option arguments [String] :repository A repository name (*Required*)
-        # @option arguments [String] :snapshot A snapshot name (*Required*)
-        # @option arguments [Hash] :body Details of what to restore
+        # @option arguments [String] :repository A repository name
+        # @option arguments [String] :snapshot A snapshot name
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         # @option arguments [Boolean] :wait_for_completion Should this request wait until the operation has completed before returning
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body Details of what to restore
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/modules-snapshots.html
         #
-        def restore(arguments={})
+        def restore(arguments = {})
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
-          raise ArgumentError, "Required argument 'snapshot' missing"   unless arguments[:snapshot]
-          repository = arguments.delete(:repository)
-          snapshot   = arguments.delete(:snapshot)
+          raise ArgumentError, "Required argument 'snapshot' missing" unless arguments[:snapshot]
+
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _repository = arguments.delete(:repository)
 
-          method = HTTP_POST
-          path   = Utils.__pathify( '_snapshot', Utils.__escape(repository), Utils.__escape(snapshot), '_restore' )
+          _snapshot = arguments.delete(:snapshot)
 
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_snapshot/#{Utils.__listify(_repository)}/#{Utils.__listify(_snapshot)}/_restore"
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = arguments[:body]
 
-          perform_request(method, path, params, body).body
+          body = arguments[:body]
+          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(:restore, [
-            :master_timeout,
-            :wait_for_completion ].freeze)
+          :master_timeout,
+          :wait_for_completion
+        ].freeze)
       end
     end
   end

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

@@ -1,39 +1,58 @@
+# 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 Snapshot
       module Actions
-
-        # Return information about a running snapshot
-        #
-        # @example Return information about all currently running snapshots
-        #
-        #     client.snapshot.status repository: 'my-backups', human: true
-        #
-        # @example Return information about a specific snapshot
-        #
-        #     client.snapshot.status repository: 'my-backups', human: true
+        # Returns information about the status of a snapshot.
         #
         # @option arguments [String] :repository A repository name
         # @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 [Hash] :headers Custom HTTP headers
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/modules-snapshots.html
         #
-        def status(arguments={})
-          repository = arguments.delete(:repository)
-          snapshot   = arguments.delete(:snapshot)
+        def status(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _repository = arguments.delete(:repository)
 
-          method = HTTP_GET
+          _snapshot = arguments.delete(:snapshot)
 
-          path   = Utils.__pathify( '_snapshot', Utils.__escape(repository), Utils.__escape(snapshot), '_status')
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _repository && _snapshot
+                     "_snapshot/#{Utils.__listify(_repository)}/#{Utils.__listify(_snapshot)}/_status"
+                   elsif _repository
+                     "_snapshot/#{Utils.__listify(_repository)}/_status"
+                   else
+                     "_snapshot/_status"
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
 
+          body = nil
           if Array(arguments[:ignore]).include?(404)
-            Utils.__rescue_from_not_found { perform_request(method, path, params, body).body }
+            Utils.__rescue_from_not_found { perform_request(method, path, params, body, headers).body }
           else
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
         end
 
@@ -41,8 +60,9 @@ module Elasticsearch
         #
         # @since 6.2.0
         ParamsRegistry.register(:status, [
-            :master_timeout,
-            :ignore_unavailable ].freeze)
+          :master_timeout,
+          :ignore_unavailable
+        ].freeze)
       end
     end
   end

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

@@ -1,33 +1,57 @@
+# 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 Snapshot
       module Actions
-
-        # Explicitly perform the verification of a repository
+        # Verifies a repository.
         #
-        # @option arguments [String] :repository A repository name (*Required*)
+        # @option arguments [String] :repository A repository name
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/modules-snapshots.html
         #
-        def verify_repository(arguments={})
+        def verify_repository(arguments = {})
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
-          repository = arguments.delete(:repository)
-          method = HTTP_POST
-          path   = Utils.__pathify( '_snapshot', Utils.__escape(repository), '_verify' )
+
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _repository = arguments.delete(:repository)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_snapshot/#{Utils.__listify(_repository)}/_verify"
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
 
-          perform_request(method, path, params, body).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(:verify_repository, [
-            :master_timeout,
-            :timeout ].freeze)
+          :master_timeout,
+          :timeout
+        ].freeze)
       end
     end
   end

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

@@ -1,36 +1,63 @@
+# 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 Tasks
       module Actions
-
-        # Cancel a specific task
+        # Cancels a task, if it can be cancelled through an API.
         #
         # @option arguments [String] :task_id Cancel the task with specified task id (node_id:task_number)
         # @option arguments [List] :nodes 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] :actions A comma-separated list of actions that should be cancelled. Leave empty to cancel all.
         # @option arguments [String] :parent_task_id Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all.
+        # @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 http://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/tasks.html
         #
-        def cancel(arguments={})
+        def cancel(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
           arguments = arguments.clone
-          task_id = arguments.delete(:task_id)
 
-          method = 'POST'
-          path   = Utils.__pathify( '_tasks', Utils.__escape(task_id), '_cancel' )
+          _task_id = arguments.delete(:task_id)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = if _task_id
+                     "_tasks/#{Utils.__listify(_task_id)}/_cancel"
+                   else
+                     "_tasks/_cancel"
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
 
-          perform_request(method, path, params, body).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(:cancel, [
-            :nodes,
-            :actions,
-            :parent_task_id ].freeze)
+          :nodes,
+          :actions,
+          :parent_task_id,
+          :wait_for_completion
+        ].freeze)
       end
     end
   end

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

@@ -1,33 +1,55 @@
+# 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 Tasks
       module Actions
-
-        # Return information about a specific task
+        # Returns information about a task.
         #
-        # @option arguments [String] :task_id Return the task with specified id (node_id:task_number) (*Required*)
+        # @option arguments [String] :task_id Return the task with specified id (node_id:task_number)
         # @option arguments [Boolean] :wait_for_completion Wait for the matching tasks to complete (default: false)
         # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/tasks.html
         #
-        def get(arguments={})
+        def get(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
           arguments = arguments.clone
-          task_id = arguments.delete(:task_id)
-          method = HTTP_GET
-          path   = Utils.__pathify '_tasks', Utils.__escape(task_id)
+
+          _task_id = arguments.delete(:task_id)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = "_tasks/#{Utils.__listify(_task_id)}"
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
 
-          perform_request(method, path, params, body).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(:get, [
-            :wait_for_completion,
-            :timeout ].freeze)
+          :wait_for_completion,
+          :timeout
+        ].freeze)
       end
     end
   end