elasticsearch-api 7.2.0 → 8.0.0

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

@@ -6,7 +6,7 @@
 # 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
+#   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
@@ -19,43 +19,42 @@ module Elasticsearch
   module API
     module Snapshot
       module Actions
-
-        # Delete a specific repository or repositories
-        #
-        # @example Delete the `my-backups` repository
+        # Deletes a repository.
         #
-        #     client.snapshot.delete_repository repository: 'my-backups'
-        #
-        # @option arguments [List] :repository A comma-separated list of repository names (*Required*)
+        # @option arguments [List] :repository Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported.
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         # @option arguments [Time] :timeout Explicit operation timeout
-        # @option arguments [Number,List] :ignore The list of HTTP errors to ignore
+        # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html
         #
-        def delete_repository(arguments={})
+        def delete_repository(arguments = {})
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
-          repository = arguments.delete(:repository)
 
-          method = HTTP_DELETE
-          path   = Utils.__pathify( '_snapshot', Utils.__listify(repository) )
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
 
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
+          arguments = arguments.clone
+
+          _repository = arguments.delete(:repository)
+
+          method = Elasticsearch::API::HTTP_DELETE
+          path   = "_snapshot/#{Utils.__listify(_repository)}"
+          params = Utils.process_params(arguments)
 
           if Array(arguments[:ignore]).include?(404)
-            Utils.__rescue_from_not_found { perform_request(method, path, params, body).body }
+            Utils.__rescue_from_not_found {
+              Elasticsearch::API::Response.new(
+                perform_request(method, path, params, body, headers)
+              )
+            }
           else
-            perform_request(method, path, params, body).body
+            Elasticsearch::API::Response.new(
+              perform_request(method, path, params, body, headers)
+            )
           end
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.1.1
-        ParamsRegistry.register(:delete_repository, [
-            :master_timeout,
-            :timeout ].freeze)
       end
     end
   end

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

@@ -6,7 +6,7 @@
 # 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
+#   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
@@ -19,56 +19,49 @@ 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']
-        #
-        # @example Return information about all snapshots in the repository
-        #
-        #     client.snapshot.get repository: 'my-backup', snapshot: '_all'
+        # Returns information about a snapshot.
         #
-        # @option arguments [String] :repository A repository name (*Required*)
-        # @option arguments [List] :snapshot A comma-separated list of snapshot names (*Required*)
-        # @option arguments [Boolean] :ignore_unavailable Whether to ignore unavailable snapshots, defaults to
-        #   false which means a SnapshotMissingException is thrown
+        # @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] :index_details Whether to include details of each index in the snapshot, if those details are available. Defaults to false.
+        # @option arguments [Boolean] :include_repository Whether to include the repository name in the snapshot info. Defaults to true.
         # @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/master/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]
 
-          method = HTTP_GET
-          path   = Utils.__pathify( '_snapshot', Utils.__escape(repository), Utils.__listify(snapshot) )
+          headers = arguments.delete(:headers) || {}
 
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
+          body = nil
+
+          arguments = arguments.clone
+
+          _repository = arguments.delete(:repository)
+
+          _snapshot = arguments.delete(:snapshot)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = "_snapshot/#{Utils.__listify(_repository)}/#{Utils.__listify(_snapshot)}"
+          params = Utils.process_params(arguments)
 
           if Array(arguments[:ignore]).include?(404)
-            Utils.__rescue_from_not_found { perform_request(method, path, params, body).body }
+            Utils.__rescue_from_not_found {
+              Elasticsearch::API::Response.new(
+                perform_request(method, path, params, body, headers)
+              )
+            }
           else
-            perform_request(method, path, params, body).body
+            Elasticsearch::API::Response.new(
+              perform_request(method, path, params, body, headers)
+            )
           end
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.1.1
-        ParamsRegistry.register(:get, [
-            :ignore_unavailable,
-            :master_timeout,
-            :verbose ].freeze)
       end
     end
   end

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

@@ -6,7 +6,7 @@
 # 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
+#   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
@@ -19,47 +19,44 @@ 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. Leave blank or use `_all`
-        #                                      to get a list of repositories
+        # @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 [Number,List] :ignore The list of HTTP errors to ignore
+        # @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/master/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) || {}
 
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
+          body = nil
+
+          arguments = arguments.clone
+
+          _repository = arguments.delete(:repository)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _repository
+                     "_snapshot/#{Utils.__listify(_repository)}"
+                   else
+                     "_snapshot"
+                   end
+          params = Utils.process_params(arguments)
 
           if Array(arguments[:ignore]).include?(404)
-            Utils.__rescue_from_not_found { perform_request(method, path, params, body).body }
+            Utils.__rescue_from_not_found {
+              Elasticsearch::API::Response.new(
+                perform_request(method, path, params, body, headers)
+              )
+            }
           else
-            perform_request(method, path, params, body).body
+            Elasticsearch::API::Response.new(
+              perform_request(method, path, params, body, headers)
+            )
           end
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.1.1
-        ParamsRegistry.register(:get_repository, [
-            :master_timeout,
-            :local ].freeze)
       end
     end
   end

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

@@ -0,0 +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
+        # Analyzes a repository for correctness and performance
+        #
+        # @option arguments [String] :repository A repository name
+        # @option arguments [Number] :blob_count Number of blobs to create during the test. Defaults to 100.
+        # @option arguments [Number] :concurrency Number of operations to run concurrently during the test. Defaults to 10.
+        # @option arguments [Number] :read_node_count Number of nodes on which to read a blob after writing. Defaults to 10.
+        # @option arguments [Number] :early_read_node_count Number of nodes on which to perform an early read on a blob, i.e. before writing has completed. Early reads are rare actions so the 'rare_action_probability' parameter is also relevant. Defaults to 2.
+        # @option arguments [Number] :seed Seed for the random number generator used to create the test workload. Defaults to a random value.
+        # @option arguments [Number] :rare_action_probability Probability of taking a rare action such as an early read or an overwrite. Defaults to 0.02.
+        # @option arguments [String] :max_blob_size Maximum size of a blob to create during the test, e.g '1gb' or '100mb'. Defaults to '10mb'.
+        # @option arguments [String] :max_total_data_size Maximum total size of all blobs to create during the test, e.g '1tb' or '100gb'. Defaults to '1gb'.
+        # @option arguments [Time] :timeout Explicit operation timeout. Defaults to '30s'.
+        # @option arguments [Boolean] :detailed Whether to return detailed results or a summary. Defaults to 'false' so that only the summary is returned.
+        # @option arguments [Boolean] :rarely_abort_writes Whether to rarely abort writes before they complete. Defaults to 'true'.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html
+        #
+        def repository_analyze(arguments = {})
+          raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _repository = arguments.delete(:repository)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_snapshot/#{Utils.__listify(_repository)}/_analyze"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -6,7 +6,7 @@
 # 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
+#   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
@@ -19,53 +19,39 @@ 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
+        # Restores a snapshot.
         #
-        #     client.snapshot.restore repository: 'my-backups',
-        #                             snapshot: 'snapshot-1',
-        #                             body: {
-        #                               rename_pattern: "^(.*)$",
-        #                               rename_replacement: "restored_$1"
-        #                             }
-        #
-        # @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 https://www.elastic.co/guide/en/elasticsearch/reference/master/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]
 
-          method = HTTP_POST
-          path   = Utils.__pathify( '_snapshot', Utils.__escape(repository), Utils.__escape(snapshot), '_restore' )
+          headers = arguments.delete(:headers) || {}
 
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = arguments[:body]
+          body = arguments.delete(:body)
 
-          perform_request(method, path, params, body).body
-        end
+          arguments = arguments.clone
 
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.1.1
-        ParamsRegistry.register(:restore, [
-            :master_timeout,
-            :wait_for_completion ].freeze)
+          _repository = arguments.delete(:repository)
+
+          _snapshot = arguments.delete(:snapshot)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_snapshot/#{Utils.__listify(_repository)}/#{Utils.__listify(_snapshot)}/_restore"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
       end
     end
   end

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

@@ -6,7 +6,7 @@
 # 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
+#   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
@@ -19,49 +19,49 @@ 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 [Boolean] :ignore_unavailable Whether to ignore unavailable snapshots, defaults to
-        #   false which means a SnapshotMissingException is thrown
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
-        # @option arguments [Number,List] :ignore The list of HTTP errors to ignore
+        # @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/master/modules-snapshots.html#_snapshot_status
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html
         #
-        def status(arguments={})
-          repository = arguments.delete(:repository)
-          snapshot   = arguments.delete(:snapshot)
+        def status(arguments = {})
+          headers = arguments.delete(:headers) || {}
 
-          method = HTTP_GET
+          body = nil
 
-          path   = Utils.__pathify( '_snapshot', Utils.__escape(repository), Utils.__escape(snapshot), '_status')
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
+          arguments = arguments.clone
+
+          _repository = arguments.delete(:repository)
+
+          _snapshot = arguments.delete(:snapshot)
+
+          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.process_params(arguments)
 
           if Array(arguments[:ignore]).include?(404)
-            Utils.__rescue_from_not_found { perform_request(method, path, params, body).body }
+            Utils.__rescue_from_not_found {
+              Elasticsearch::API::Response.new(
+                perform_request(method, path, params, body, headers)
+              )
+            }
           else
-            perform_request(method, path, params, body).body
+            Elasticsearch::API::Response.new(
+              perform_request(method, path, params, body, headers)
+            )
           end
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.1.1
-        ParamsRegistry.register(:status, [
-            :ignore_unavailable,
-            :master_timeout ].freeze)
       end
     end
   end

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

@@ -6,7 +6,7 @@
 # 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
+#   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
@@ -19,32 +19,34 @@ 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 https://www.elastic.co/guide/en/elasticsearch/reference/master/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' )
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
 
-          perform_request(method, path, params, body).body
-        end
+          headers = arguments.delete(:headers) || {}
 
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.1.1
-        ParamsRegistry.register(:verify_repository, [
-            :master_timeout,
-            :timeout ].freeze)
+          body = nil
+
+          arguments = arguments.clone
+
+          _repository = arguments.delete(:repository)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_snapshot/#{Utils.__listify(_repository)}/_verify"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
       end
     end
   end

data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/delete_lifecycle.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 SnapshotLifecycleManagement
+      module Actions
+        # Deletes an existing snapshot lifecycle policy.
+        #
+        # @option arguments [String] :policy_id The id of the snapshot lifecycle policy to remove
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-delete-policy.html
+        #
+        def delete_lifecycle(arguments = {})
+          raise ArgumentError, "Required argument 'policy_id' missing" unless arguments[:policy_id]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _policy_id = arguments.delete(:policy_id)
+
+          method = Elasticsearch::API::HTTP_DELETE
+          path   = "_slm/policy/#{Utils.__listify(_policy_id)}"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_lifecycle.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 SnapshotLifecycleManagement
+      module Actions
+        # Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time.
+        #
+        # @option arguments [String] :policy_id The id of the snapshot lifecycle policy to be executed
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-lifecycle.html
+        #
+        def execute_lifecycle(arguments = {})
+          raise ArgumentError, "Required argument 'policy_id' missing" unless arguments[:policy_id]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _policy_id = arguments.delete(:policy_id)
+
+          method = Elasticsearch::API::HTTP_PUT
+          path   = "_slm/policy/#{Utils.__listify(_policy_id)}/_execute"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end