elasticsearch-api 8.17.2 → 9.0.0

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

@@ -15,30 +15,111 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Snapshot
       module Actions
-        # Analyzes a repository for correctness and performance
+        # Analyze a snapshot repository.
+        # Analyze the performance characteristics and any incorrect behaviour found in a repository.
+        # The response exposes implementation details of the analysis which may change from version to version.
+        # The response body format is therefore not considered stable and may be different in newer versions.
+        # There are a large number of third-party storage systems available, not all of which are suitable for use as a snapshot repository by Elasticsearch.
+        # Some storage systems behave incorrectly, or perform poorly, especially when accessed concurrently by multiple clients as the nodes of an Elasticsearch cluster do. This API performs a collection of read and write operations on your repository which are designed to detect incorrect behaviour and to measure the performance characteristics of your storage system.
+        # The default values for the parameters are deliberately low to reduce the impact of running an analysis inadvertently and to provide a sensible starting point for your investigations.
+        # Run your first analysis with the default parameter values to check for simple problems.
+        # If successful, run a sequence of increasingly large analyses until you encounter a failure or you reach a +blob_count+ of at least +2000+, a +max_blob_size+ of at least +2gb+, a +max_total_data_size+ of at least +1tb+, and a +register_operation_count+ of at least +100+.
+        # Always specify a generous timeout, possibly +1h+ or longer, to allow time for each analysis to run to completion.
+        # Perform the analyses using a multi-node cluster of a similar size to your production cluster so that it can detect any problems that only arise when the repository is accessed by many nodes at once.
+        # If the analysis fails, Elasticsearch detected that your repository behaved unexpectedly.
+        # This usually means you are using a third-party storage system with an incorrect or incompatible implementation of the API it claims to support.
+        # If so, this storage system is not suitable for use as a snapshot repository.
+        # You will need to work with the supplier of your storage system to address the incompatibilities that Elasticsearch detects.
+        # If the analysis is successful, the API returns details of the testing process, optionally including how long each operation took.
+        # You can use this information to determine the performance of your storage system.
+        # If any operation fails or returns an incorrect result, the API returns an error.
+        # If the API returns an error, it may not have removed all the data it wrote to the repository.
+        # The error will indicate the location of any leftover data and this path is also recorded in the Elasticsearch logs.
+        # You should verify that this location has been cleaned up correctly.
+        # If there is still leftover data at the specified location, you should manually remove it.
+        # If the connection from your client to Elasticsearch is closed while the client is waiting for the result of the analysis, the test is cancelled.
+        # Some clients are configured to close their connection if no response is received within a certain timeout.
+        # An analysis takes a long time to complete so you might need to relax any such client-side timeouts.
+        # On cancellation the analysis attempts to clean up the data it was writing, but it may not be able to remove it all.
+        # The path to the leftover data is recorded in the Elasticsearch logs.
+        # You should verify that this location has been cleaned up correctly.
+        # If there is still leftover data at the specified location, you should manually remove it.
+        # If the analysis is successful then it detected no incorrect behaviour, but this does not mean that correct behaviour is guaranteed.
+        # The analysis attempts to detect common bugs but it does not offer 100% coverage.
+        # Additionally, it does not test the following:
+        # * Your repository must perform durable writes. Once a blob has been written it must remain in place until it is deleted, even after a power loss or similar disaster.
+        # * Your repository must not suffer from silent data corruption. Once a blob has been written, its contents must remain unchanged until it is deliberately modified or deleted.
+        # * Your repository must behave correctly even if connectivity from the cluster is disrupted. Reads and writes may fail in this case, but they must not return incorrect results.
+        # IMPORTANT: An analysis writes a substantial amount of data to your repository and then reads it back again.
+        # This consumes bandwidth on the network between the cluster and the repository, and storage space and I/O bandwidth on the repository itself.
+        # You must ensure this load does not affect other users of these systems.
+        # Analyses respect the repository settings +max_snapshot_bytes_per_sec+ and +max_restore_bytes_per_sec+ if available and the cluster setting +indices.recovery.max_bytes_per_sec+ which you can use to limit the bandwidth they consume.
+        # NOTE: This API is intended for exploratory use by humans. You should expect the request parameters and the response format to vary in future versions.
+        # NOTE: Different versions of Elasticsearch may perform different checks for repository compatibility, with newer versions typically being stricter than older ones.
+        # A storage system that passes repository analysis with one version of Elasticsearch may fail with a different version.
+        # This indicates it behaves incorrectly in ways that the former version did not detect.
+        # You must work with the supplier of your storage system to address the incompatibilities detected by the repository analysis API in any version of Elasticsearch.
+        # NOTE: This API may not work correctly in a mixed-version cluster.
+        # *Implementation details*
+        # NOTE: This section of documentation describes how the repository analysis API works in this version of Elasticsearch, but you should expect the implementation to vary between versions. The request parameters and response format depend on details of the implementation so may also be different in newer versions.
+        # The analysis comprises a number of blob-level tasks, as set by the +blob_count+ parameter and a number of compare-and-exchange operations on linearizable registers, as set by the +register_operation_count+ parameter.
+        # These tasks are distributed over the data and master-eligible nodes in the cluster for execution.
+        # For most blob-level tasks, the executing node first writes a blob to the repository and then instructs some of the other nodes in the cluster to attempt to read the data it just wrote.
+        # The size of the blob is chosen randomly, according to the +max_blob_size+ and +max_total_data_size+ parameters.
+        # If any of these reads fails then the repository does not implement the necessary read-after-write semantics that Elasticsearch requires.
+        # For some blob-level tasks, the executing node will instruct some of its peers to attempt to read the data before the writing process completes.
+        # These reads are permitted to fail, but must not return partial data.
+        # If any read returns partial data then the repository does not implement the necessary atomicity semantics that Elasticsearch requires.
+        # For some blob-level tasks, the executing node will overwrite the blob while its peers are reading it.
+        # In this case the data read may come from either the original or the overwritten blob, but the read operation must not return partial data or a mix of data from the two blobs.
+        # If any of these reads returns partial data or a mix of the two blobs then the repository does not implement the necessary atomicity semantics that Elasticsearch requires for overwrites.
+        # The executing node will use a variety of different methods to write the blob.
+        # For instance, where applicable, it will use both single-part and multi-part uploads.
+        # Similarly, the reading nodes will use a variety of different methods to read the data back again.
+        # For instance they may read the entire blob from start to end or may read only a subset of the data.
+        # For some blob-level tasks, the executing node will cancel the write before it is complete.
+        # In this case, it still instructs some of the other nodes in the cluster to attempt to read the blob but all of these reads must fail to find the blob.
+        # Linearizable registers are special blobs that Elasticsearch manipulates using an atomic compare-and-exchange operation.
+        # This operation ensures correct and strongly-consistent behavior even when the blob is accessed by multiple nodes at the same time.
+        # The detailed implementation of the compare-and-exchange operation on linearizable registers varies by repository type.
+        # Repository analysis verifies that that uncontended compare-and-exchange operations on a linearizable register blob always succeed.
+        # Repository analysis also verifies that contended operations either succeed or report the contention but do not return incorrect results.
+        # If an operation fails due to contention, Elasticsearch retries the operation until it succeeds.
+        # Most of the compare-and-exchange operations performed by repository analysis atomically increment a counter which is represented as an 8-byte blob.
+        # Some operations also verify the behavior on small blobs with sizes other than 8 bytes.
         #
-        # @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 [String] :repository The name of the repository. (*Required*)
+        # @option arguments [Integer] :blob_count The total number of blobs to write to the repository during the test.
+        #  For realistic experiments, you should set it to at least +2000+. Server default: 100.
+        # @option arguments [Integer] :concurrency The number of operations to run concurrently during the test. Server default: 10.
+        # @option arguments [Boolean] :detailed Indicates whether to return detailed results, including timing information for every operation performed during the analysis.
+        #  If false, it returns only a summary of the analysis.
+        # @option arguments [Integer] :early_read_node_count The number of nodes on which to perform an early read operation while writing each blob.
+        #  Early read operations are only rarely performed. Server default: 2.
+        # @option arguments [Integer, String] :max_blob_size The maximum size of a blob to be written during the test.
+        #  For realistic experiments, you should set it to at least +2gb+. Server default: 10mb.
+        # @option arguments [Integer, String] :max_total_data_size An upper limit on the total size of all the blobs written during the test.
+        #  For realistic experiments, you should set it to at least +1tb+. Server default: 1gb.
+        # @option arguments [Float] :rare_action_probability The probability of performing a rare action such as an early read, an overwrite, or an aborted write on each blob. Server default: 0.02.
+        # @option arguments [Boolean] :rarely_abort_writes Indicates whether to rarely cancel writes before they complete. Server default: true.
+        # @option arguments [Integer] :read_node_count The number of nodes on which to read a blob after writing. Server default: 10.
+        # @option arguments [Integer] :register_operation_count The minimum number of linearizable register operations to perform in total.
+        #  For realistic experiments, you should set it to at least +100+. Server default: 10.
+        # @option arguments [Integer] :seed The seed for the pseudo-random number generator used to generate the list of operations performed during the test.
+        #  To repeat the same set of operations in multiple experiments, use the same seed in each experiment.
+        #  Note that the operations are performed concurrently so might not always happen in the same order on each run.
+        # @option arguments [Time] :timeout The period of time to wait for the test to complete.
+        #  If no response is received before the timeout expires, the test is cancelled and returns an error. Server default: 30s.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/modules-snapshots.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-repository-analyze
         #
         def repository_analyze(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'snapshot.repository_analyze' }
@@ -58,7 +139,7 @@ module Elasticsearch
           _repository = arguments.delete(:repository)
 
           method = Elasticsearch::API::HTTP_POST
-          path   = "_snapshot/#{Utils.__listify(_repository)}/_analyze"
+          path   = "_snapshot/#{Utils.listify(_repository)}/_analyze"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,28 +15,43 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Snapshot
       module Actions
-        # Restores a snapshot.
+        # Restore a snapshot.
+        # Restore a snapshot of a cluster or data streams and indices.
+        # You can restore a snapshot only to a running cluster with an elected master node.
+        # The snapshot repository must be registered and available to the cluster.
+        # The snapshot and cluster versions must be compatible.
+        # To restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks.
+        # Before you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API:
+        # +
+        # GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream
+        # +
+        # If no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices.
+        # If your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot.
         #
-        # @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 [String] :repository The name of the repository to restore a snapshot from. (*Required*)
+        # @option arguments [String] :snapshot The name of the snapshot to restore. (*Required*)
+        # @option arguments [Time] :master_timeout The period to wait for the master node.
+        #  If the master node is not available before the timeout expires, the request fails and returns an error.
+        #  To indicate that the request should never timeout, set it to +-1+. Server default: 30s.
+        # @option arguments [Boolean] :wait_for_completion If +true+, the request returns a response when the restore operation completes.
+        #  The operation is complete when it finishes all attempts to recover primary shards for restored indices.
+        #  This applies even if one or more of the recovery attempts fail.If +false+, the request returns a response when the restore operation initializes.
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body Details of what to restore
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/modules-snapshots.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-restore
         #
         def restore(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'snapshot.restore' }
 
-          defined_params = %i[repository snapshot].each_with_object({}) do |variable, set_variables|
+          defined_params = [:repository, :snapshot].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
@@ -54,7 +69,7 @@ module Elasticsearch
           _snapshot = arguments.delete(:snapshot)
 
           method = Elasticsearch::API::HTTP_POST
-          path   = "_snapshot/#{Utils.__listify(_repository)}/#{Utils.__listify(_snapshot)}/_restore"
+          path   = "_snapshot/#{Utils.listify(_repository)}/#{Utils.listify(_snapshot)}/_restore"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,27 +15,44 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Snapshot
       module Actions
-        # Returns information about the status of a snapshot.
+        # Get the snapshot status.
+        # Get a detailed description of the current state for each shard participating in the snapshot.
+        # Note that this API should be used only to obtain detailed shard-level information for ongoing snapshots.
+        # If this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API.
+        # If you omit the +<snapshot>+ request path parameter, the request retrieves information only for currently running snapshots.
+        # This usage is preferred.
+        # If needed, you can specify +<repository>+ and +<snapshot>+ to retrieve information for specific snapshots, even if they're not currently running.
+        # WARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive.
+        # The API requires a read from the repository for each shard in each snapshot.
+        # For example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards).
+        # Depending on the latency of your storage, such requests can take an extremely long time to return results.
+        # These requests can also tax machine resources and, when using cloud storage, incur high processing costs.
         #
-        # @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 [String] :repository The snapshot repository name used to limit the request.
+        #  It supports wildcards (+*+) if +<snapshot>+ isn't specified.
+        # @option arguments [String, Array<String>] :snapshot A comma-separated list of snapshots to retrieve status for.
+        #  The default is currently running snapshots.
+        #  Wildcards (+*+) are not supported.
+        # @option arguments [Boolean] :ignore_unavailable If +false+, the request returns an error for any snapshots that are unavailable.
+        #  If +true+, the request ignores snapshots that are unavailable, such as those that are corrupted or temporarily cannot be returned.
+        # @option arguments [Time] :master_timeout The period to wait for the master node.
+        #  If the master node is not available before the timeout expires, the request fails and returns an error.
+        #  To indicate that the request should never timeout, set it to +-1+. Server default: 30s.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/modules-snapshots.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-status
         #
         def status(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'snapshot.status' }
 
-          defined_params = %i[repository snapshot].each_with_object({}) do |variable, set_variables|
+          defined_params = [:repository, :snapshot].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
@@ -51,16 +68,16 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_GET
           path   = if _repository && _snapshot
-                     "_snapshot/#{Utils.__listify(_repository)}/#{Utils.__listify(_snapshot)}/_status"
+                     "_snapshot/#{Utils.listify(_repository)}/#{Utils.listify(_snapshot)}/_status"
                    elsif _repository
-                     "_snapshot/#{Utils.__listify(_repository)}/_status"
+                     "_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 do
+            Utils.rescue_from_not_found do
               Elasticsearch::API::Response.new(
                 perform_request(method, path, params, body, headers, request_opts)
               )

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

@@ -15,21 +15,26 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Snapshot
       module Actions
-        # Verifies a repository.
+        # Verify a snapshot repository.
+        # Check for common misconfigurations in a snapshot repository.
         #
-        # @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 [String] :repository The name of the snapshot repository to verify. (*Required*)
+        # @option arguments [Time] :master_timeout The period to wait for the master node.
+        #  If the master node is not available before the timeout expires, the request fails and returns an error.
+        #  To indicate that the request should never timeout, set it to +-1+. Server default: 30s.
+        # @option arguments [Time] :timeout The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.
+        #  If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged.
+        #  To indicate that the request should never timeout, set it to +-1+. Server default: 30s.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/modules-snapshots.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-verify-repository
         #
         def verify_repository(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'snapshot.verify_repository' }
@@ -49,7 +54,7 @@ module Elasticsearch
           _repository = arguments.delete(:repository)
 
           method = Elasticsearch::API::HTTP_POST
-          path   = "_snapshot/#{Utils.__listify(_repository)}/_verify"
+          path   = "_snapshot/#{Utils.listify(_repository)}/_verify"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/delete_lifecycle.rb

@@ -15,21 +15,25 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module SnapshotLifecycleManagement
       module Actions
-        # Deletes an existing snapshot lifecycle policy.
+        # Delete a policy.
+        # Delete a snapshot lifecycle policy definition.
+        # This operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots.
         #
-        # @option arguments [String] :policy_id The id of the snapshot lifecycle policy to remove
-        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
-        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [String] :policy_id The id of the snapshot lifecycle policy to remove (*Required*)
+        # @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
+        #  If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
+        # @option arguments [Time] :timeout The period to wait for a response.
+        #  If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/slm-api-delete-policy.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-slm-delete-lifecycle
         #
         def delete_lifecycle(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'slm.delete_lifecycle' }
@@ -49,7 +53,7 @@ module Elasticsearch
           _policy_id = arguments.delete(:policy_id)
 
           method = Elasticsearch::API::HTTP_DELETE
-          path   = "_slm/policy/#{Utils.__listify(_policy_id)}"
+          path   = "_slm/policy/#{Utils.listify(_policy_id)}"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_lifecycle.rb

@@ -15,21 +15,25 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module SnapshotLifecycleManagement
       module Actions
-        # Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time.
+        # Run a policy.
+        # Immediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time.
+        # The snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance.
         #
-        # @option arguments [String] :policy_id The id of the snapshot lifecycle policy to be executed
-        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
-        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [String] :policy_id The id of the snapshot lifecycle policy to be executed (*Required*)
+        # @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
+        #  If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
+        # @option arguments [Time] :timeout The period to wait for a response.
+        #  If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/slm-api-execute-lifecycle.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-slm-execute-lifecycle
         #
         def execute_lifecycle(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'slm.execute_lifecycle' }
@@ -49,7 +53,7 @@ module Elasticsearch
           _policy_id = arguments.delete(:policy_id)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_slm/policy/#{Utils.__listify(_policy_id)}/_execute"
+          path   = "_slm/policy/#{Utils.listify(_policy_id)}/_execute"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_retention.rb

@@ -15,20 +15,24 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module SnapshotLifecycleManagement
       module Actions
-        # Deletes any snapshots that are expired according to the policy's retention rules.
+        # Run a retention policy.
+        # Manually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules.
+        # The retention policy is normally applied according to its schedule.
         #
-        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
-        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
+        #  If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
+        # @option arguments [Time] :timeout The period to wait for a response.
+        #  If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/slm-api-execute-retention.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-slm-execute-retention
         #
         def execute_retention(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'slm.execute_retention' }
@@ -36,7 +40,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = nil
+          body = nil
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_slm/_execute_retention'

data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_lifecycle.rb

@@ -15,21 +15,24 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module SnapshotLifecycleManagement
       module Actions
-        # Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts.
+        # Get policy information.
+        # Get snapshot lifecycle policy definitions and information about the latest snapshot attempts.
         #
-        # @option arguments [List] :policy_id Comma-separated list of snapshot lifecycle policies to retrieve
-        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
-        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [String, Array<String>] :policy_id Comma-separated list of snapshot lifecycle policies to retrieve
+        # @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
+        #  If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
+        # @option arguments [Time] :timeout The period to wait for a response.
+        #  If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/slm-api-get-policy.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-slm-get-lifecycle
         #
         def get_lifecycle(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'slm.get_lifecycle' }
@@ -48,7 +51,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_GET
           path   = if _policy_id
-                     "_slm/policy/#{Utils.__listify(_policy_id)}"
+                     "_slm/policy/#{Utils.listify(_policy_id)}"
                    else
                      '_slm/policy'
                    end

data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_stats.rb

@@ -15,20 +15,21 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module SnapshotLifecycleManagement
       module Actions
-        # Returns global and policy-level statistics about actions taken by snapshot lifecycle management.
+        # Get snapshot lifecycle management statistics.
+        # Get global and policy-level statistics about actions taken by snapshot lifecycle management.
         #
-        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
-        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
+        # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/slm-api-get-stats.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-slm-get-stats
         #
         def get_stats(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'slm.get_stats' }
@@ -36,7 +37,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = nil
+          body = nil
 
           method = Elasticsearch::API::HTTP_GET
           path   = '_slm/stats'

data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_status.rb

@@ -15,20 +15,24 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module SnapshotLifecycleManagement
       module Actions
-        # Retrieves the status of snapshot lifecycle management (SLM).
+        # Get the snapshot lifecycle management status.
         #
-        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
-        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
+        #  If no response is received before the timeout expires, the request fails and returns an error.
+        #  To indicate that the request should never timeout, set it to +-1+. Server default: 30s.
+        # @option arguments [Time] :timeout The period to wait for a response.
+        #  If no response is received before the timeout expires, the request fails and returns an error.
+        #  To indicate that the request should never timeout, set it to +-1+. Server default: 30s.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/slm-api-get-status.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-slm-get-status
         #
         def get_status(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'slm.get_status' }
@@ -36,7 +40,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = nil
+          body = nil
 
           method = Elasticsearch::API::HTTP_GET
           path   = '_slm/status'