elasticsearch-api 9.0.3 → 9.0.4

data/lib/elasticsearch/api/actions/watcher/execute_watch.rb

@@ -30,11 +30,23 @@ module Elasticsearch
         # You can use the run watch API to run watches that are not yet registered by specifying the watch definition inline.
         # This serves as great tool for testing and debugging your watches prior to adding them to Watcher.
         # When Elasticsearch security features are enabled on your cluster, watches are run with the privileges of the user that stored the watches.
-        # If your user is allowed to read index +a+, but not index +b+, then the exact same set of rules will apply during execution of a watch.
+        # If your user is allowed to read index `a`, but not index `b`, then the exact same set of rules will apply during execution of a watch.
         # When using the run watch API, the authorization data of the user that called the API will be used as a base, instead of the information who stored the watch.
+        # Refer to the external documentation for examples of watch execution requests, including existing, customized, and inline watches.
         #
         # @option arguments [String] :id The watch identifier.
         # @option arguments [Boolean] :debug Defines whether the watch runs in debug mode.
+        # @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/watcher/get_settings.rb

@@ -23,11 +23,22 @@ module Elasticsearch
     module Watcher
       module Actions
         # Get Watcher index settings.
-        # Get settings for the Watcher internal index (+.watches+).
-        # Only a subset of settings are shown, for example +index.auto_expand_replicas+ and +index.number_of_replicas+.
+        # Get settings for the Watcher internal index (`.watches`).
+        # Only a subset of settings are shown, for example `index.auto_expand_replicas` and `index.number_of_replicas`.
         #
         # @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.
+        # @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-watcher-get-settings

data/lib/elasticsearch/api/actions/watcher/get_watch.rb

@@ -25,6 +25,17 @@ module Elasticsearch
         # Get a watch.
         #
         # @option arguments [String] :id The watch identifier. (*Required*)
+        # @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-watcher-get-watch
@@ -48,7 +59,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_GET
           path   = "_watcher/watch/#{Utils.listify(_id)}"
-          params = {}
+          params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/watcher/put_watch.rb

@@ -23,21 +23,32 @@ module Elasticsearch
     module Watcher
       module Actions
         # Create or update a watch.
-        # When a watch is registered, a new document that represents the watch is added to the +.watches+ index and its trigger is immediately registered with the relevant trigger engine.
-        # Typically for the +schedule+ trigger, the scheduler is the trigger engine.
+        # When a watch is registered, a new document that represents the watch is added to the `.watches` index and its trigger is immediately registered with the relevant trigger engine.
+        # Typically for the `schedule` trigger, the scheduler is the trigger engine.
         # IMPORTANT: You must use Kibana or this API to create a watch.
-        # Do not add a watch directly to the +.watches+ index by using the Elasticsearch index API.
-        # If Elasticsearch security features are enabled, do not give users write privileges on the +.watches+ index.
+        # Do not add a watch directly to the `.watches` index by using the Elasticsearch index API.
+        # If Elasticsearch security features are enabled, do not give users write privileges on the `.watches` index.
         # When you add a watch you can also define its initial active state by setting the *active* parameter.
         # When Elasticsearch security features are enabled, your watch can index or search only on indices for which the user that stored the watch has privileges.
-        # If the user is able to read index +a+, but not index +b+, the same will apply when the watch runs.
+        # If the user is able to read index `a`, but not index `b`, the same will apply when the watch runs.
         #
         # @option arguments [String] :id The identifier for the watch. (*Required*)
         # @option arguments [Boolean] :active The initial state of the watch.
-        #  The default value is +true+, which means the watch is active by default. Server default: true.
+        #  The default value is `true`, which means the watch is active by default. Server default: true.
         # @option arguments [Integer] :if_primary_term only update the watch if the last operation that has changed the watch has the specified primary term
         # @option arguments [Integer] :if_seq_no only update the watch if the last operation that has changed the watch has the specified sequence number
         # @option arguments [Integer] :version Explicit version number for concurrency control
+        # @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/watcher/query_watches.rb

@@ -24,8 +24,19 @@ module Elasticsearch
       module Actions
         # Query watches.
         # Get all registered watches in a paginated manner and optionally filter watches by a query.
-        # Note that only the +_id+ and +metadata.*+ fields are queryable or sortable.
+        # Note that only the `_id` and `metadata.*` fields are queryable or sortable.
         #
+        # @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
         #
@@ -46,7 +57,7 @@ module Elasticsearch
                    end
 
           path   = '_watcher/_query/watches'
-          params = {}
+          params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/watcher/start.rb

@@ -26,6 +26,17 @@ module Elasticsearch
         # Start the Watcher service if it is not already running.
         #
         # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. 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-watcher-start

data/lib/elasticsearch/api/actions/watcher/stats.rb

@@ -26,8 +26,19 @@ module Elasticsearch
         # This API always returns basic metrics.
         # You retrieve more metrics by using the metric parameter.
         #
-        # @option arguments [Watchermetric] :metric Defines which additional metrics are included in the response.
+        # @option arguments [String, Array<String>] :metric Defines which additional metrics are included in the response.
         # @option arguments [Boolean] :emit_stacktraces Defines whether stack traces are generated for each watch that is running.
+        # @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-watcher-stats

data/lib/elasticsearch/api/actions/watcher/stop.rb

@@ -27,7 +27,18 @@ module Elasticsearch
         #
         # @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-watcher-stop

data/lib/elasticsearch/api/actions/watcher/update_settings.rb

@@ -23,17 +23,28 @@ module Elasticsearch
     module Watcher
       module Actions
         # Update Watcher index settings.
-        # Update settings for the Watcher internal index (+.watches+).
+        # Update settings for the Watcher internal index (`.watches`).
         # Only a subset of settings can be modified.
-        # This includes +index.auto_expand_replicas+, +index.number_of_replicas+, +index.routing.allocation.exclude.*+,
-        # +index.routing.allocation.include.*+ and +index.routing.allocation.require.*+.
-        # Modification of +index.routing.allocation.include._tier_preference+ is an exception and is not allowed as the
-        # Watcher shards must always be in the +data_content+ tier.
+        # This includes `index.auto_expand_replicas`, `index.number_of_replicas`, `index.routing.allocation.exclude.*`,
+        # `index.routing.allocation.include.*` and `index.routing.allocation.require.*`.
+        # Modification of `index.routing.allocation.include._tier_preference` is an exception and is not allowed as the
+        # Watcher shards must always be in the `data_content` tier.
         #
         # @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.
         # @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.
+        # @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/xpack/info.rb

@@ -29,10 +29,21 @@ module Elasticsearch
         # * Feature information for the features that are currently enabled and available under the current license.
         #
         # @option arguments [Array<String>] :categories A comma-separated list of the information categories to include in the response.
-        #  For example, +build,license,features+.
+        #  For example, `build,license,features`.
         # @option arguments [Boolean] :accept_enterprise If this param is used it must be set to true
         # @option arguments [Boolean] :human Defines whether additional human-readable information is included in the response.
         #  In particular, it adds descriptions and a tag line. 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-info

data/lib/elasticsearch/api/actions/xpack/usage.rb

@@ -28,7 +28,18 @@ 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 [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/group/endpoint-xpack

data/lib/elasticsearch/api/version.rb

@@ -17,7 +17,7 @@
 
 module Elasticsearch
   module API
-    VERSION = '9.0.3'.freeze
-    ES_SPECIFICATION_COMMIT = '922e9456120bb3e729432d252a36ddd2b705df96'.freeze
+    VERSION = '9.0.4'.freeze
+    ES_SPECIFICATION_COMMIT = '6a749236ec86e65b50e31dc888c727c0aede67a3'.freeze
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-api
 version: !ruby/object:Gem::Version
-  version: 9.0.3
+  version: 9.0.4
 platform: ruby
 authors:
 - Elastic Client Library Maintainers
 bindir: bin
 cert_chain: []
-date: 2025-05-19 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -269,8 +269,8 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.md
 - LICENSE.txt
+- README.md
 files:
 - ".gitignore"
 - LICENSE.txt
@@ -495,6 +495,7 @@ files:
 - lib/elasticsearch/api/actions/inference/put_azureaistudio.rb
 - lib/elasticsearch/api/actions/inference/put_azureopenai.rb
 - lib/elasticsearch/api/actions/inference/put_cohere.rb
+- lib/elasticsearch/api/actions/inference/put_custom.rb
 - lib/elasticsearch/api/actions/inference/put_elasticsearch.rb
 - lib/elasticsearch/api/actions/inference/put_elser.rb
 - lib/elasticsearch/api/actions/inference/put_googleaistudio.rb
@@ -818,7 +819,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.7.1
 specification_version: 4
 summary: Ruby API for Elasticsearch.
 test_files: []