elasticsearch-api 9.2.0 → 9.3.0

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/terms_enum.rb

@@ -25,7 +25,7 @@ module Elasticsearch
       # Discover terms that match a partial string in an index.
       # This API is designed for low-latency look-ups used in auto-complete scenarios.
       #
-      # @option arguments [String] :index A comma-separated list of data streams, indices, and index aliases to search.
+      # @option arguments [String, Array] :index A comma-separated list of data streams, indices, and index aliases to search.
       #  Wildcard (`*`) expressions are supported.
       #  To search all data streams or indices, omit this parameter or use `*`  or `_all`. (*Required*)
       # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors

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

@@ -58,7 +58,7 @@ module Elasticsearch
       # @option arguments [String] :preference The node or shard the operation should be performed on.
       #  It is random by default.
       # @option arguments [Boolean] :realtime If true, the request is real-time as opposed to near-real-time. Server default: true.
-      # @option arguments [String] :routing A custom value that is used to route operations to a specific shard.
+      # @option arguments [String, Array<String>] :routing A custom value that is used to route operations to a specific shard.
       # @option arguments [Boolean] :term_statistics If `true`, the response includes:
       #  - The total term frequency (how often a term occurs in all documents).
       #  - The document frequency (the number of documents containing the current term).

data/lib/elasticsearch/api/actions/text_structure/find_field_structure.rb

@@ -36,7 +36,7 @@ module Elasticsearch
         # If the structure finder produces unexpected results, specify the `explain` query parameter and an explanation will appear in the response.
         # It helps determine why the returned structure was chosen.
         #
-        # @option arguments [String] :column_names If `format` is set to `delimited`, you can specify the column names in a comma-separated list.
+        # @option arguments [String, Array<String>] :column_names If `format` is set to `delimited`, you can specify the column names in a comma-separated list.
         #  If this parameter is not specified, the structure finder uses the column names from the header row of the text.
         #  If the text does not have a header row, columns are named "column1", "column2", "column3", for example.
         # @option arguments [String] :delimiter If you have set `format` to `delimited`, you can specify the character used to delimit the values in each row.

data/lib/elasticsearch/api/actions/text_structure/find_message_structure.rb

@@ -37,7 +37,7 @@ module Elasticsearch
         # If the structure finder produces unexpected results, specify the `explain` query parameter and an explanation will appear in the response.
         # It helps determine why the returned structure was chosen.
         #
-        # @option arguments [String] :column_names If the format is `delimited`, you can specify the column names in a comma-separated list.
+        # @option arguments [String, Array<String>] :column_names If the format is `delimited`, you can specify the column names in a comma-separated list.
         #  If this parameter is not specified, the structure finder uses the column names from the header row of the text.
         #  If the text does not have a header role, columns are named "column1", "column2", "column3", for example.
         # @option arguments [String] :delimiter If you the format is `delimited`, you can specify the character used to delimit the values in each row.

data/lib/elasticsearch/api/actions/text_structure/find_structure.rb

@@ -40,7 +40,7 @@ module Elasticsearch
         #  It must be a character set that is supported by the JVM that Elasticsearch uses.
         #  For example, `UTF-8`, `UTF-16LE`, `windows-1252`, or `EUC-JP`.
         #  If this parameter is not specified, the structure finder chooses an appropriate character set.
-        # @option arguments [String] :column_names If you have set format to `delimited`, you can specify the column names in a comma-separated list.
+        # @option arguments [String, Array<String>] :column_names If you have set format to `delimited`, you can specify the column names in a comma-separated list.
         #  If this parameter is not specified, the structure finder uses the column names from the header row of the text.
         #  If the text does not have a header role, columns are named "column1", "column2", "column3", for example.
         # @option arguments [String] :delimiter If you have set `format` to `delimited`, you can specify the character used to delimit the values in each row.

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.rb

@@ -48,7 +48,7 @@ module Elasticsearch
       #  If 'false', it does nothing with refreshes. Server default: false.
       # @option arguments [Boolean] :require_alias If `true`, the destination must be an index alias.
       # @option arguments [Integer] :retry_on_conflict The number of times the operation should be retried when a conflict occurs. Server default: 0.
-      # @option arguments [String] :routing A custom value used to route operations to a specific shard.
+      # @option arguments [String, Array<String>] :routing A custom value used to route operations to a specific shard.
       # @option arguments [Time] :timeout The period to wait for the following operations: dynamic mapping updates and waiting for active shards.
       #  Elasticsearch waits for at least the timeout period before failing.
       #  The actual wait time could be longer, particularly when multiple waits occur. Server default: 1m.

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

@@ -109,7 +109,7 @@ 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.
@@ -128,7 +128,7 @@ module Elasticsearch
       # @option arguments [Boolean] :request_cache If `true`, the request cache is used for this request.
       #  It defaults to the index-level setting.
       # @option arguments [Float] :requests_per_second The throttle for this request in sub-requests per second. Server default: -1.
-      # @option arguments [String] :routing A custom value used to route operations to a specific shard.
+      # @option arguments [String, Array<String>] :routing A custom value used to route operations to a specific shard.
       # @option arguments [Time] :scroll The period to retain the search context for scrolling. Server default: 5m.
       # @option arguments [Integer] :scroll_size The size of the scroll request that powers the operation. Server default: 1000.
       # @option arguments [Time] :search_timeout An explicit timeout for each search request.

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/utils.rb

@@ -102,7 +102,6 @@ module Elasticsearch
         operations = %w[index create delete update]
 
         case
-
         # Hashes with `:data`
         when payload.any? { |d| d.is_a?(Hash) && d.values.first.is_a?(Hash) && operations.include?(d.keys.first.to_s) && (d.values.first[:data] || d.values.first['data']) }
           payload = payload.
@@ -117,17 +116,14 @@ module Elasticsearch
             end.
             map { |item| Elasticsearch::API.serializer.dump(item) }
           payload << '' unless payload.empty?
-
         # Array of strings
         when payload.all? { |d| d.is_a? String }
           payload << ''
-
         # Header/Data pairs
         else
           payload = payload.map { |item| Elasticsearch::API.serializer.dump(item) }
           payload << ''
         end
-
         payload = payload.join("\n")
       end
 

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.3.0'.freeze
+    ES_SPECIFICATION_COMMIT = 'c2cdbfe0c3812eedea4a98c5d8375f240b779a0f'.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.3.0
 platform: ruby
 authors:
 - Elastic Client Library Maintainers
@@ -9,6 +9,20 @@ bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -285,6 +299,7 @@ files:
 - lib/elasticsearch/api/actions/bulk.rb
 - lib/elasticsearch/api/actions/cat/aliases.rb
 - lib/elasticsearch/api/actions/cat/allocation.rb
+- lib/elasticsearch/api/actions/cat/circuit_breaker.rb
 - lib/elasticsearch/api/actions/cat/component_templates.rb
 - lib/elasticsearch/api/actions/cat/count.rb
 - lib/elasticsearch/api/actions/cat/fielddata.rb
@@ -391,8 +406,11 @@ files:
 - lib/elasticsearch/api/actions/esql/async_query_delete.rb
 - lib/elasticsearch/api/actions/esql/async_query_get.rb
 - lib/elasticsearch/api/actions/esql/async_query_stop.rb
+- lib/elasticsearch/api/actions/esql/delete_view.rb
 - lib/elasticsearch/api/actions/esql/get_query.rb
+- lib/elasticsearch/api/actions/esql/get_view.rb
 - lib/elasticsearch/api/actions/esql/list_queries.rb
+- lib/elasticsearch/api/actions/esql/put_view.rb
 - lib/elasticsearch/api/actions/esql/query.rb
 - lib/elasticsearch/api/actions/exists.rb
 - lib/elasticsearch/api/actions/exists_source.rb
@@ -438,6 +456,7 @@ files:
 - lib/elasticsearch/api/actions/indices/delete_data_stream.rb
 - lib/elasticsearch/api/actions/indices/delete_data_stream_options.rb
 - lib/elasticsearch/api/actions/indices/delete_index_template.rb
+- lib/elasticsearch/api/actions/indices/delete_sample_configuration.rb
 - lib/elasticsearch/api/actions/indices/delete_template.rb
 - lib/elasticsearch/api/actions/indices/disk_usage.rb
 - lib/elasticsearch/api/actions/indices/downsample.rb
@@ -451,6 +470,7 @@ files:
 - lib/elasticsearch/api/actions/indices/forcemerge.rb
 - lib/elasticsearch/api/actions/indices/get.rb
 - lib/elasticsearch/api/actions/indices/get_alias.rb
+- lib/elasticsearch/api/actions/indices/get_all_sample_configuration.rb
 - lib/elasticsearch/api/actions/indices/get_data_lifecycle.rb
 - lib/elasticsearch/api/actions/indices/get_data_lifecycle_stats.rb
 - lib/elasticsearch/api/actions/indices/get_data_stream.rb
@@ -461,6 +481,9 @@ files:
 - lib/elasticsearch/api/actions/indices/get_index_template.rb
 - lib/elasticsearch/api/actions/indices/get_mapping.rb
 - lib/elasticsearch/api/actions/indices/get_migrate_reindex_status.rb
+- lib/elasticsearch/api/actions/indices/get_sample.rb
+- lib/elasticsearch/api/actions/indices/get_sample_configuration.rb
+- lib/elasticsearch/api/actions/indices/get_sample_stats.rb
 - lib/elasticsearch/api/actions/indices/get_settings.rb
 - lib/elasticsearch/api/actions/indices/get_template.rb
 - lib/elasticsearch/api/actions/indices/migrate_reindex.rb
@@ -475,6 +498,7 @@ files:
 - lib/elasticsearch/api/actions/indices/put_data_stream_settings.rb
 - lib/elasticsearch/api/actions/indices/put_index_template.rb
 - lib/elasticsearch/api/actions/indices/put_mapping.rb
+- lib/elasticsearch/api/actions/indices/put_sample_configuration.rb
 - lib/elasticsearch/api/actions/indices/put_settings.rb
 - lib/elasticsearch/api/actions/indices/put_template.rb
 - lib/elasticsearch/api/actions/indices/recovery.rb
@@ -514,11 +538,14 @@ files:
 - lib/elasticsearch/api/actions/inference/put_elser.rb
 - lib/elasticsearch/api/actions/inference/put_googleaistudio.rb
 - lib/elasticsearch/api/actions/inference/put_googlevertexai.rb
+- lib/elasticsearch/api/actions/inference/put_groq.rb
 - lib/elasticsearch/api/actions/inference/put_hugging_face.rb
 - lib/elasticsearch/api/actions/inference/put_jinaai.rb
 - lib/elasticsearch/api/actions/inference/put_llama.rb
 - lib/elasticsearch/api/actions/inference/put_mistral.rb
+- lib/elasticsearch/api/actions/inference/put_nvidia.rb
 - lib/elasticsearch/api/actions/inference/put_openai.rb
+- lib/elasticsearch/api/actions/inference/put_openshift_ai.rb
 - lib/elasticsearch/api/actions/inference/put_voyageai.rb
 - lib/elasticsearch/api/actions/inference/put_watsonx.rb
 - lib/elasticsearch/api/actions/inference/rerank.rb
@@ -841,7 +868,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: []