elasticsearch-api 7.17.11 → 9.0.2

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

@@ -14,50 +14,62 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# 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
-        # Deletes a snapshot.
+        # Delete snapshots.
         #
-        # @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 [String] :repository The name of the repository to delete a snapshot from. (*Required*)
+        # @option arguments [String] :snapshot A comma-separated list of snapshot names to delete.
+        #  It also accepts wildcards (+*+). (*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 [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/modules-snapshots.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-delete
         #
         def delete(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'snapshot.delete' }
+
+          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?
+
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
           raise ArgumentError, "Required argument 'snapshot' missing" unless arguments[:snapshot]
 
+          arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          arguments = arguments.clone
+          body = nil
 
           _repository = arguments.delete(:repository)
 
           _snapshot = arguments.delete(:snapshot)
 
           method = Elasticsearch::API::HTTP_DELETE
-          path   = "_snapshot/#{Utils.__listify(_repository)}/#{Utils.__listify(_snapshot)}"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          path   = "_snapshot/#{Utils.listify(_repository)}/#{Utils.listify(_snapshot)}"
+          params = Utils.process_params(arguments)
 
-          body = nil
           if Array(arguments[:ignore]).include?(404)
-            Utils.__rescue_from_not_found { perform_request(method, path, params, body, headers).body }
+            Utils.rescue_from_not_found do
+              Elasticsearch::API::Response.new(
+                perform_request(method, path, params, body, headers, request_opts)
+              )
+            end
           else
-            perform_request(method, path, params, body, headers).body
+            Elasticsearch::API::Response.new(
+              perform_request(method, path, params, body, headers, request_opts)
+            )
           end
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:delete, [
-          :master_timeout
-        ].freeze)
       end
     end
   end

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

@@ -14,48 +14,63 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# 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
-        # Deletes a repository.
+        # Delete snapshot repositories.
+        # When a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots.
+        # The snapshots themselves are left untouched and in place.
         #
-        # @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 [String, Array<String>] :repository The ame of the snapshot repositories to unregister.
+        #  Wildcard (+*+) patterns are supported. (*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/7.17/modules-snapshots.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-delete-repository
         #
         def delete_repository(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'snapshot.delete_repository' }
+
+          defined_params = [:repository].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?
+
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
 
+          arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          arguments = arguments.clone
+          body = nil
 
           _repository = arguments.delete(:repository)
 
           method = Elasticsearch::API::HTTP_DELETE
-          path   = "_snapshot/#{Utils.__listify(_repository)}"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          path   = "_snapshot/#{Utils.listify(_repository)}"
+          params = Utils.process_params(arguments)
 
-          body = nil
           if Array(arguments[:ignore]).include?(404)
-            Utils.__rescue_from_not_found { perform_request(method, path, params, body, headers).body }
+            Utils.rescue_from_not_found do
+              Elasticsearch::API::Response.new(
+                perform_request(method, path, params, body, headers, request_opts)
+              )
+            end
           else
-            perform_request(method, path, params, body, headers).body
+            Elasticsearch::API::Response.new(
+              perform_request(method, path, params, body, headers, request_opts)
+            )
           end
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:delete_repository, [
-          :master_timeout,
-          :timeout
-        ].freeze)
       end
     end
   end

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

@@ -14,72 +14,89 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# 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 a snapshot.
+        # Get snapshot information.
+        # NOTE: The +after+ parameter and +next+ field enable you to iterate through snapshots with some consistency guarantees regarding concurrent creation or deletion of snapshots.
+        # It is guaranteed that any snapshot that exists at the beginning of the iteration and is not concurrently deleted will be seen during the iteration.
+        # Snapshots concurrently created may be seen during an iteration.
         #
-        # @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 [String] :sort Allows setting a sort order for the result. Defaults to start_time (options: start_time, duration, name, repository, index_count, shard_count, failed_shard_count)
-        # @option arguments [Integer] :size Maximum number of snapshots to return. Defaults to 0 which means return all that match without limit.
-        # @option arguments [String] :order Sort order (options: asc, desc)
-        # @option arguments [String] :from_sort_value Value of the current sort column at which to start retrieval.
-        # @option arguments [String] :after Offset identifier to start pagination from as returned by the 'next' field in the response body.
-        # @option arguments [Integer] :offset Numeric offset to start pagination based on the snapshots matching the request. Defaults to 0
-        # @option arguments [String] :slm_policy_filter Filter snapshots by a comma-separated list of SLM policy names that snapshots belong to. Accepts wildcards. Use the special pattern '_none' to match snapshots without an SLM policy
-        # @option arguments [Boolean] :verbose Whether to show verbose snapshot info or only show the basic info found in the repository index blob
+        # @option arguments [String] :repository A comma-separated list of snapshot repository names used to limit the request.
+        #  Wildcard (+*+) expressions are supported. (*Required*)
+        # @option arguments [String, Array<String>] :snapshot A comma-separated list of snapshot names to retrieve
+        #  Wildcards (+*+) are supported.
+        #  - To get information about all snapshots in a registered repository, use a wildcard (+*+) or +_all+.
+        #  - To get information about any snapshots that are currently running, use +_current+. (*Required*)
+        # @option arguments [String] :after An offset identifier to start pagination from as returned by the next field in the response body.
+        # @option arguments [String] :from_sort_value The value of the current sort column at which to start retrieval.
+        #  It can be a string +snapshot-+ or a repository name when sorting by snapshot or repository name.
+        #  It can be a millisecond time value or a number when sorting by +index-+ or shard count.
+        # @option arguments [Boolean] :ignore_unavailable If +false+, the request returns an error for any snapshots that are unavailable.
+        # @option arguments [Boolean] :index_details If +true+, the response includes additional information about each index in the snapshot comprising the number of shards in the index, the total size of the index in bytes, and the maximum number of segments per shard in the index.
+        #  The default is +false+, meaning that this information is omitted.
+        # @option arguments [Boolean] :index_names If +true+, the response includes the name of each index in each snapshot. Server default: true.
+        # @option arguments [Boolean] :include_repository If +true+, the response includes the repository name in each snapshot. Server default: true.
+        # @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 [String] :order The sort order.
+        #  Valid values are +asc+ for ascending and +desc+ for descending order.
+        #  The default behavior is ascending order. Server default: asc.
+        # @option arguments [Integer] :offset Numeric offset to start pagination from based on the snapshots matching this request. Using a non-zero value for this parameter is mutually exclusive with using the after parameter. Defaults to 0. Server default: 0.
+        # @option arguments [Integer] :size The maximum number of snapshots to return.
+        #  The default is 0, which means to return all that match the request without limit. Server default: 0.
+        # @option arguments [String] :slm_policy_filter Filter snapshots by a comma-separated list of snapshot lifecycle management (SLM) policy names that snapshots belong to.You can use wildcards (+*+) and combinations of wildcards followed by exclude patterns starting with +-+.
+        #  For example, the pattern +*,-policy-a-\*+ will return all snapshots except for those that were created by an SLM policy with a name starting with +policy-a-+.
+        #  Note that the wildcard pattern +*+ matches all snapshots created by an SLM policy but not those snapshots that were not created by an SLM policy.
+        #  To include snapshots that were not created by an SLM policy, you can use the special pattern +_none+ that will match all snapshots without an SLM policy.
+        # @option arguments [String] :sort The sort order for the result.
+        #  The default behavior is sorting by snapshot start time stamp. Server default: start_time.
+        # @option arguments [Boolean] :verbose If +true+, returns additional information about each snapshot such as the version of Elasticsearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted.NOTE: The parameters +size+, +order+, +after+, +from_sort_value+, +offset+, +slm_policy_filter+, and +sort+ are not supported when you set +verbose=false+ and the sort order for requests with +verbose=false+ is undefined. Server default: true.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/modules-snapshots.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-get
         #
         def get(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'snapshot.get' }
+
+          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?
+
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
           raise ArgumentError, "Required argument 'snapshot' missing" unless arguments[:snapshot]
 
+          arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          arguments = arguments.clone
+          body = nil
 
           _repository = arguments.delete(:repository)
 
           _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__)
+          path   = "_snapshot/#{Utils.listify(_repository)}/#{Utils.listify(_snapshot)}"
+          params = Utils.process_params(arguments)
 
-          body = nil
           if Array(arguments[:ignore]).include?(404)
-            Utils.__rescue_from_not_found { perform_request(method, path, params, body, headers).body }
+            Utils.rescue_from_not_found do
+              Elasticsearch::API::Response.new(
+                perform_request(method, path, params, body, headers, request_opts)
+              )
+            end
           else
-            perform_request(method, path, params, body, headers).body
+            Elasticsearch::API::Response.new(
+              perform_request(method, path, params, body, headers, request_opts)
+            )
           end
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:get, [
-          :master_timeout,
-          :ignore_unavailable,
-          :index_details,
-          :include_repository,
-          :sort,
-          :size,
-          :order,
-          :from_sort_value,
-          :after,
-          :offset,
-          :slm_policy_filter,
-          :verbose
-        ].freeze)
       end
     end
   end

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

@@ -14,50 +14,62 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# 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 a repository.
+        # Get snapshot repository information.
         #
-        # @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 [String, Array<String>] :repository A comma-separated list of snapshot repository names used to limit the request.
+        #  Wildcard (+*+) expressions are supported including combining wildcards with exclude patterns starting with +-+.To get information about all snapshot repositories registered in the cluster, omit this parameter or use +*+ or +_all+.
+        # @option arguments [Boolean] :local If +true+, the request gets information from the local node only.
+        #  If +false+, the request gets information from the master node.
+        # @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: to 30s.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/modules-snapshots.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-get-repository
         #
         def get_repository(arguments = {})
-          headers = arguments.delete(:headers) || {}
+          request_opts = { endpoint: arguments[:endpoint] || 'snapshot.get_repository' }
+
+          defined_params = [:repository].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?
 
           arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
 
           _repository = arguments.delete(:repository)
 
           method = Elasticsearch::API::HTTP_GET
           path   = if _repository
-                     "_snapshot/#{Utils.__listify(_repository)}"
+                     "_snapshot/#{Utils.listify(_repository)}"
                    else
-                     "_snapshot"
+                     '_snapshot'
                    end
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          params = Utils.process_params(arguments)
 
-          body = nil
           if Array(arguments[:ignore]).include?(404)
-            Utils.__rescue_from_not_found { perform_request(method, path, params, body, headers).body }
+            Utils.rescue_from_not_found do
+              Elasticsearch::API::Response.new(
+                perform_request(method, path, params, body, headers, request_opts)
+              )
+            end
           else
-            perform_request(method, path, params, body, headers).body
+            Elasticsearch::API::Response.new(
+              perform_request(method, path, params, body, headers, request_opts)
+            )
           end
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:get_repository, [
-          :master_timeout,
-          :local
-        ].freeze)
       end
     end
   end

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

@@ -14,62 +14,138 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# 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/7.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' }
+
+          defined_params = [:repository].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?
+
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
 
+          arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          arguments = arguments.clone
+          body = nil
 
           _repository = arguments.delete(:repository)
 
           method = Elasticsearch::API::HTTP_POST
-          path   = "_snapshot/#{Utils.__listify(_repository)}/_analyze"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          path   = "_snapshot/#{Utils.listify(_repository)}/_analyze"
+          params = Utils.process_params(arguments)
 
-          body = nil
-          perform_request(method, path, params, body, headers).body
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:repository_analyze, [
-          :blob_count,
-          :concurrency,
-          :read_node_count,
-          :early_read_node_count,
-          :seed,
-          :rare_action_probability,
-          :max_blob_size,
-          :max_total_data_size,
-          :timeout,
-          :detailed,
-          :rarely_abort_writes
-        ].freeze)
       end
     end
   end