elasticsearch-api 9.2.0 → 9.2.1

data/lib/elasticsearch/api/actions/streams/logs_disable.rb

@@ -24,10 +24,12 @@ module Elasticsearch
       module Actions
         # Disable logs stream.
         # Turn off the logs stream feature for this cluster.
-        # This functionality is Experimental and may be changed or removed
-        # completely in a future release. Elastic will take a best effort approach
-        # to fix any issues, but experimental features are not subject to the
-        # support SLA of official GA features.
+        #
+        # This API is only available behind a feature flag: `logs_stream`.
+        #
+        # This functionality is in technical preview and may be changed or removed in a future
+        # release. Elastic will apply best effort to fix any issues, but features in technical
+        # preview are not subject to the support SLA of official GA features.
         #
         # @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.

data/lib/elasticsearch/api/actions/streams/logs_enable.rb

@@ -27,10 +27,12 @@ module Elasticsearch
         # NOTE: To protect existing data, this feature can be turned on only if the
         # cluster does not have existing indices or data streams that match the pattern `logs|logs.*`.
         # If those indices or data streams exist, a `409 - Conflict` response and error is returned.
-        # This functionality is Experimental and may be changed or removed
-        # completely in a future release. Elastic will take a best effort approach
-        # to fix any issues, but experimental features are not subject to the
-        # support SLA of official GA features.
+        #
+        # This API is only available behind a feature flag: `logs_stream`.
+        #
+        # This functionality is in technical preview and may be changed or removed in a future
+        # release. Elastic will apply best effort to fix any issues, but features in technical
+        # preview are not subject to the support SLA of official GA features.
         #
         # @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.

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

@@ -24,10 +24,12 @@ module Elasticsearch
       module Actions
         # Get the status of streams.
         # Get the current status for all types of streams.
-        # This functionality is Experimental and may be changed or removed
-        # completely in a future release. Elastic will take a best effort approach
-        # to fix any issues, but experimental features are not subject to the
-        # support SLA of official GA features.
+        #
+        # This API is only available behind a feature flag: `logs_stream`.
+        #
+        # This functionality is in technical preview and may be changed or removed in a future
+        # release. Elastic will apply best effort to fix any issues, but features in technical
+        # preview are not subject to the support SLA of official GA features.
         #
         # @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 [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors

data/lib/elasticsearch/api/actions/synonyms/put_synonym.rb

@@ -24,7 +24,6 @@ module Elasticsearch
       module Actions
         # Create or update a synonym set.
         # Synonyms sets are limited to a maximum of 10,000 synonym rules per set.
-        # If you need to manage more synonym rules, you can create multiple synonym sets.
         # When an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices.
         # This is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.
         # For practical examples of how to create or update a synonyms set, refer to the External documentation.

data/lib/elasticsearch/api/actions/tasks/cancel.rb

@@ -31,10 +31,9 @@ module Elasticsearch
         # The cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible.
         # To troubleshoot why a cancelled task does not complete promptly, use the get task information API with the `?detailed` parameter to identify the other tasks the system is running.
         # You can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task.
-        # This functionality is Experimental and may be changed or removed
-        # completely in a future release. Elastic will take a best effort approach
-        # to fix any issues, but experimental features are not subject to the
-        # support SLA of official GA features.
+        # This functionality is in technical preview and may be changed or removed in a future
+        # release. Elastic will apply best effort to fix any issues, but features in technical
+        # preview are not subject to the support SLA of official GA features.
         #
         # @option arguments [String] :task_id The task identifier.
         # @option arguments [String, Array<String>] :actions A comma-separated list or wildcard expression of actions that is used to limit the request.

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

@@ -27,10 +27,9 @@ module Elasticsearch
         # WARNING: The task management API is new and should still be considered a beta feature.
         # The API may change in ways that are not backwards compatible.
         # If the task identifier is not found, a 404 response code indicates that there are no resources that match the request.
-        # This functionality is Experimental and may be changed or removed
-        # completely in a future release. Elastic will take a best effort approach
-        # to fix any issues, but experimental features are not subject to the
-        # support SLA of official GA features.
+        # This functionality is in technical preview and may be changed or removed in a future
+        # release. Elastic will apply best effort to fix any issues, but features in technical
+        # preview are not subject to the support SLA of official GA features.
         #
         # @option arguments [String] :task_id The task identifier. (*Required*)
         # @option arguments [Time] :timeout The period to wait for a response.

data/lib/elasticsearch/api/actions/tasks/list.rb

@@ -78,10 +78,9 @@ module Elasticsearch
         # In this example, `X-Opaque-Id: 123456` is the ID as a part of the response header.
         # The `X-Opaque-Id` in the task `headers` is the ID for the task that was initiated by the REST request.
         # The `X-Opaque-Id` in the children `headers` is the child task of the task that was initiated by the REST request.
-        # This functionality is Experimental and may be changed or removed
-        # completely in a future release. Elastic will take a best effort approach
-        # to fix any issues, but experimental features are not subject to the
-        # support SLA of official GA features.
+        # This functionality is in technical preview and may be changed or removed in a future
+        # release. Elastic will apply best effort to fix any issues, but features in technical
+        # preview are not subject to the support SLA of official GA features.
         #
         # @option arguments [String, Array<String>] :actions A comma-separated list or wildcard expression of actions used to limit the request.
         #  For example, you can use `cluser:*` to retrieve all cluster-related tasks.

data/lib/elasticsearch/api/actions/transform/get_node_stats.rb

@@ -22,11 +22,23 @@ module Elasticsearch
   module API
     module Transform
       module Actions
-        # Retrieves transform usage information for transform nodes
+        # Get node stats.
+        # Get per-node information about transform usage.
         #
+        # @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
+        #  `"exists_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/guide/en/elasticsearch/reference/current/get-transform-node-stats.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-get-node-stats
         #
         def get_node_stats(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'transform.get_node_stats' }
@@ -38,7 +50,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_GET
           path   = '_transform/_node_stats'
-          params = {}
+          params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/transform/get_transform_stats.rb

@@ -37,7 +37,7 @@ module Elasticsearch
         #  there are no matches or only partial matches. Server default: true.
         # @option arguments [Integer] :from Skips the specified number of transforms. Server default: 0.
         # @option arguments [Integer] :size Specifies the maximum number of transforms to obtain. Server default: 100.
-        # @option arguments [Time] :timeout Controls the time to wait for the stats
+        # @option arguments [Time] :timeout Controls the time to wait for the stats 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

data/lib/elasticsearch/api/actions/update_by_query.rb

@@ -109,14 +109,14 @@ module Elasticsearch
       #  This parameter can be used only when the `q` query string parameter is specified.
       # @option arguments [String, Array<String>] :expand_wildcards The type of index that wildcard patterns can match.
       #  If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
-      #  It supports comma-separated values, such as `open,hidden`.
+      #  It supports comma-separated values, such as `open,hidden`. Server default: open.
       # @option arguments [Integer] :from Skips the specified number of documents. Server default: 0.
       # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index.
       # @option arguments [Boolean] :lenient If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.
       #  This parameter can be used only when the `q` query string parameter is specified.
       # @option arguments [Integer] :max_docs The maximum number of documents to process.
       #  It defaults to all documents.
-      #  When set to a value less then or equal to `scroll_size` then a scroll will not be used to retrieve the results for the operation.
+      #  When set to a value less than or equal to `scroll_size` and `conflicts` is set to `abort`, a scroll will not be used to retrieve the results for the operation.
       # @option arguments [String] :pipeline The ID of the pipeline to use to preprocess incoming documents.
       #  If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.
       #  If a final pipeline is configured it will always run, regardless of the value of this parameter.

data/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb

@@ -27,7 +27,7 @@ module Elasticsearch
       #
       # @option arguments [String] :task_id The ID for the task. (*Required*)
       # @option arguments [Float] :requests_per_second The throttle for this request in sub-requests per second.
-      #  To turn off throttling, set it to `-1`. Server default: -1.
+      #  To turn off throttling, set it to `-1`. (*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

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

@@ -35,8 +35,8 @@ module Elasticsearch
         # @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.
-        # @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] :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.

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

@@ -30,7 +30,7 @@ module Elasticsearch
         #
         # @option arguments [Array<String>] :categories A comma-separated list of the information categories to include in the response.
         #  For example, `build,license,features`.
-        # @option arguments [Boolean] :accept_enterprise If this param is used it must be set to true
+        # @option arguments [Boolean] :accept_enterprise If used, this otherwise ignored parameter 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

data/lib/elasticsearch/api/version.rb

@@ -17,7 +17,7 @@
 
 module Elasticsearch
   module API
-    VERSION = '9.2.0'.freeze
-    ES_SPECIFICATION_COMMIT = 'd520d9e8cf14cad487de5e0654007686c395b494'.freeze
+    VERSION = '9.2.1'.freeze
+    ES_SPECIFICATION_COMMIT = '49022a2c08d291955de83e26c583b7dc628fb558'.freeze
   end
 end

data/lib/elasticsearch/api.rb

@@ -28,6 +28,7 @@ module Elasticsearch
   # It includes the namespace modules from ./api/actions
   module API
     include Elasticsearch::API::Actions
+
     DEFAULT_SERIALIZER = MultiJson
 
     HTTP_GET          = 'GET'.freeze

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-api
 version: !ruby/object:Gem::Version
-  version: 9.2.0
+  version: 9.2.1
 platform: ruby
 authors:
 - Elastic Client Library Maintainers
@@ -841,7 +841,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Ruby API for Elasticsearch.
 test_files: []