RubyGems - elasticsearch-api - Versions diffs - 9.0.2 → 9.0.4 - Mend

elasticsearch-api 9.0.2 → 9.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (518) hide show

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

@@ -26,10 +26,23 @@ module Elasticsearch
         #
         # @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*)
+        #  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.
+        #  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 matching snapshots are all deleted.
+        #  If `false`, the request returns a response as soon as the deletes are scheduled. Server default: true.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-delete

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

@@ -27,13 +27,24 @@ module Elasticsearch
         # The snapshots themselves are left untouched and in place.
         #
         # @option arguments [String, Array<String>] :repository The ame of the snapshot repositories to unregister.
-        #  Wildcard (+*+) patterns are supported. (*Required*)
+        #  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.
+        #  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.
+        #  To indicate that the request should never timeout, set it to `-1`. Server default: 30s.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-delete-repository

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

@@ -23,40 +23,51 @@ module Elasticsearch
     module Snapshot
       module Actions
         # 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.
+        # 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 comma-separated list of snapshot repository names used to limit the request.
-        #  Wildcard (+*+) expressions are supported. (*Required*)
+        #  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*)
+        #  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.
+        #  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.
+        #  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] :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 [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 [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-get

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

@@ -25,12 +25,23 @@ module Elasticsearch
         # Get snapshot repository information.
         #
         # @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.
+        #  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.
+        #  To indicate that the request should never timeout, set it to `-1`. Server default: to 30s.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-get-repository

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

@@ -30,8 +30,8 @@ module 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.
+        # 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.
@@ -60,7 +60,7 @@ module Elasticsearch
         # 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.
+        # 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.
@@ -69,10 +69,10 @@ module 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.
+        # 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.
+        # 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.
@@ -97,26 +97,37 @@ module Elasticsearch
         #
         # @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.
+        #  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.
+        #  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.
+        #  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.
+        #  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 [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-repository-analyze

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

@@ -29,9 +29,11 @@ module Elasticsearch
         # 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.
         #
@@ -39,10 +41,21 @@ module Elasticsearch
         # @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.
+        #  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.
+        #  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 [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #

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

@@ -26,9 +26,9 @@ module Elasticsearch
         # 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.
+        # 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.
+        # 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).
@@ -36,15 +36,26 @@ module Elasticsearch
         # These requests can also tax machine resources and, when using cloud storage, incur high processing costs.
         #
         # @option arguments [String] :repository The snapshot repository name used to limit the request.
-        #  It supports wildcards (+*+) if +<snapshot>+ isn't specified.
+        #  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.
+        #  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.
+        #  To indicate that the request should never timeout, set it to `-1`. Server default: 30s.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-status

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

@@ -28,10 +28,21 @@ module Elasticsearch
         # @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.
+        #  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.
+        #  To indicate that the request should never timeout, set it to `-1`. Server default: 30s.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-verify-repository

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

@@ -31,6 +31,17 @@ module Elasticsearch
         #  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 [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-slm-delete-lifecycle

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

@@ -31,6 +31,17 @@ module Elasticsearch
         #  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 [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-slm-execute-lifecycle

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

@@ -30,6 +30,17 @@ module Elasticsearch
         #  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 [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-slm-execute-retention

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

@@ -30,6 +30,17 @@ module Elasticsearch
         #  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 [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-slm-get-lifecycle

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

@@ -27,6 +27,17 @@ module Elasticsearch
         #
         # @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 [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-slm-get-stats

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

@@ -26,10 +26,21 @@ module Elasticsearch
         #
         # @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.
+        #  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.
+        #  To indicate that the request should never timeout, set it to `-1`. Server default: 30s.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-slm-get-status

data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/put_lifecycle.rb CHANGED Viewed

@@ -30,10 +30,21 @@ module Elasticsearch
         # @option arguments [String] :policy_id The identifier for the snapshot lifecycle policy you want to create or update. (*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.
-        #  To indicate that the request should never timeout, set it to +-1+. Server default: 30s.
+        #  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.
+        #  To indicate that the request should never timeout, set it to `-1`. Server default: 30s.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #

data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/start.rb CHANGED Viewed

@@ -28,10 +28,21 @@ module Elasticsearch
         #
         # @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.
+        #  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.
+        #  To indicate that the request should never timeout, set it to `-1`. Server default: 30s.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-slm-start

data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/stop.rb CHANGED Viewed

@@ -32,10 +32,21 @@ module Elasticsearch
         #
         # @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.
+        #  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.
+        #  To indicate that the request should never timeout, set it to `-1`. Server default: 30s.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-slm-stop

data/lib/elasticsearch/api/actions/sql/clear_cursor.rb CHANGED Viewed

@@ -24,6 +24,17 @@ module Elasticsearch
       module Actions
         # Clear an SQL search cursor.
         #
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
@@ -41,7 +52,7 @@ module Elasticsearch
           method = Elasticsearch::API::HTTP_POST
           path   = '_sql/close'
-          params = {}
+          params = Utils.process_params(arguments)
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)