elasticsearch-api 9.1.2 → 9.2.0

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

@@ -108,26 +108,33 @@ 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.
-        # @option arguments [Integer] :concurrency The number of operations to run concurrently during the test. Server default: 10.
+        #  For realistic experiments, set this parameter to at least `2000`. Server default: 100.
+        # @option arguments [Integer] :concurrency The number of operations to run concurrently during the test.
+        #  For realistic experiments, leave this parameter unset. 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.
+        #  Early read operations are only rarely performed.
+        #  For realistic experiments, leave this parameter unset. 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, set this parameter to at least `2gb`. Server default: 10mb.
         # @option arguments [Integer, String] :max_total_data_size An upper limit on the total size of all the blobs written during the test.
-        #  For realistic experiments, you should set it to at least `1tb`. Server default: 1gb.
-        # @option arguments [Float] :rare_action_probability The probability of performing a rare action such as an early read, an overwrite, or an aborted write on each blob. Server default: 0.02.
-        # @option arguments [Boolean] :rarely_abort_writes Indicates whether to rarely cancel writes before they complete. Server default: true.
-        # @option arguments [Integer] :read_node_count The number of nodes on which to read a blob after writing. Server default: 10.
+        #  For realistic experiments, set this parameter 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.
+        #  For realistic experiments, leave this parameter unset. Server default: 0.02.
+        # @option arguments [Boolean] :rarely_abort_writes Indicates whether to rarely cancel writes before they complete.
+        #  For realistic experiments, leave this parameter unset. Server default: true.
+        # @option arguments [Integer] :read_node_count The number of nodes on which to read a blob after writing.
+        #  For realistic experiments, leave this parameter unset. 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, set this parameter 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.
+        #  For realistic experiments, leave this parameter unset.
         # @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.
+        #  If no response is received before the timeout expires, the test is cancelled and returns an error.
+        #  For realistic experiments, set this parameter sufficiently long to allow the test to complete. 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/snapshot/status.rb

@@ -29,6 +29,11 @@ module Elasticsearch
         # 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.
+        # Note that the stats will not be available for any shard snapshots in an ongoing snapshot completed by a node that (even momentarily) left the cluster.
+        # Loading the stats from the repository is an expensive operation (see the WARNING below).
+        # Therefore the stats values for such shards will be -1 even though the "stage" value will be "DONE", in order to minimize latency.
+        # A "description" field will be present for a shard snapshot completed by a departed node explaining why the shard snapshot's stats results are invalid.
+        # Consequently, the total stats for the index will be less than expected due to the missing values from these shards.
         # 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).

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

@@ -58,6 +58,7 @@ module Elasticsearch
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
           raise ArgumentError, "Required argument 'policy_id' missing" unless arguments[:policy_id]
 
           arguments = arguments.clone

data/lib/elasticsearch/api/actions/sql/get_async.rb

@@ -33,7 +33,7 @@ module Elasticsearch
         #  You must specify a format using this parameter or the `Accept` HTTP header.
         #  If you specify both, the API uses this parameter.
         # @option arguments [Time] :keep_alive The retention period for the search and its results.
-        #  It defaults to the `keep_alive` period for the original SQL search.
+        #  It defaults to the `keep_alive` period for the original SQL search. Server default: 5d.
         # @option arguments [Time] :wait_for_completion_timeout The period to wait for complete results.
         #  It defaults to no timeout, meaning the request waits for complete search results.
         # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors

data/lib/elasticsearch/api/actions/sql/query.rb

@@ -28,6 +28,14 @@ module Elasticsearch
         # @option arguments [String] :format The format for the response.
         #  You can also specify a format using the `Accept` HTTP header.
         #  If you specify both this parameter and the `Accept` HTTP header, this parameter takes precedence.
+        # @option arguments [String] :project_routing Specifies a subset of projects to target for the search using project
+        #  metadata tags in a subset of Lucene query syntax.
+        #  Allowed Lucene queries: the _alias tag and a single value (possibly wildcarded).
+        #  Examples:
+        #   _alias:my-project
+        #   _alias:_origin
+        #   _alias:*pr*
+        #  Supported in serverless only.
         # @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/streams/logs_disable.rb

@@ -22,11 +22,31 @@ module Elasticsearch
   module API
     module Streams
       module Actions
-        # Disable the Logs Streams feature for this cluster
+        # 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.
         #
+        # @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 [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
+        #  `"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/master/streams-logs-disable.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch#TODO
         #
         def logs_disable(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'streams.logs_disable' }
@@ -38,7 +58,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_streams/logs/_disable'
-          params = {}
+          params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

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

@@ -22,11 +22,34 @@ module Elasticsearch
   module API
     module Streams
       module Actions
-        # Enable the Logs Streams feature for this cluster
+        # Enable logs stream.
+        # Turn on the logs stream feature for this cluster.
+        # 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.
         #
+        # @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 [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
+        #  `"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/master/streams-logs-enable.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch#TODO
         #
         def logs_enable(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'streams.logs_enable' }
@@ -38,7 +61,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_streams/logs/_enable'
-          params = {}
+          params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

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

@@ -22,11 +22,28 @@ module Elasticsearch
   module API
     module Streams
       module Actions
-        # Return the current status of the streams feature for each streams type
+        # 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.
         #
+        # @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
+        #  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/master/streams-status.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch#TODO
         #
         def status(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'streams.status' }
@@ -38,7 +55,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_GET
           path   = '_streams/status'
-          params = {}
+          params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

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

@@ -88,7 +88,7 @@ module Elasticsearch
         # @option arguments [Boolean] :detailed If `true`, the response includes detailed information about the running tasks.
         #  This information is useful to distinguish tasks from each other but is more costly to run.
         # @option arguments [String] :group_by A key that is used to group tasks in the response.
-        #  The task lists can be grouped either by nodes or by parent tasks.
+        #  The task lists can be grouped either by nodes or by parent tasks. Server default: nodes.
         # @option arguments [String, Array] :nodes A comma-separated list of node IDs or names that is used to limit the returned information.
         # @option arguments [String] :parent_task_id A parent task identifier that is used to limit returned information.
         #  To return all tasks, omit this parameter or use a value of `-1`.

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

@@ -52,6 +52,7 @@ module Elasticsearch
         end
         request_opts[:defined_params] = defined_params unless defined_params.empty?
 
+        raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
 
         arguments = arguments.clone
@@ -61,12 +62,7 @@ module Elasticsearch
 
         _index = arguments.delete(:index)
 
-        method = if body
-                   Elasticsearch::API::HTTP_POST
-                 else
-                   Elasticsearch::API::HTTP_GET
-                 end
-
+        method = Elasticsearch::API::HTTP_POST
         path   = "#{Utils.listify(_index)}/_terms_enum"
         params = Utils.process_params(arguments)
 

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

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Transform
       module Actions
-        # Retrieves transform usage information for transform nodes.
+        # Retrieves transform usage information for transform nodes
         #
         # @option arguments [Hash] :headers Custom HTTP headers
         #

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

@@ -103,8 +103,8 @@ module Elasticsearch
       # @option arguments [Boolean] :analyze_wildcard If `true`, wildcard and prefix queries are analyzed.
       #  This parameter can be used only when the `q` query string parameter is specified.
       # @option arguments [String] :conflicts The preferred behavior when update by query hits version conflicts: `abort` or `proceed`. Server default: abort.
-      # @option arguments [String] :default_operator The default operator for query string query: `AND` or `OR`.
-      #  This parameter can be used only when the `q` query string parameter is specified. Server default: OR.
+      # @option arguments [String] :default_operator The default operator for query string query: `and` or `or`.
+      #  This parameter can be used only when the `q` query string parameter is specified. Server default: or.
       # @option arguments [String] :df The field to use as default where no field prefix is given in the query string.
       #  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.

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

@@ -27,7 +27,7 @@ module Elasticsearch
         # 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.
+        #  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

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

@@ -62,6 +62,7 @@ module Elasticsearch
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
           raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
 
           arguments = arguments.clone

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

@@ -31,7 +31,7 @@ module Elasticsearch
         # 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.
+        #  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.
         # @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.1.2'.freeze
-    ES_SPECIFICATION_COMMIT = 'eeef9c87c1273e5dd3a5a313768bfa6728cd39cc'.freeze
+    VERSION = '9.2.0'.freeze
+    ES_SPECIFICATION_COMMIT = 'd520d9e8cf14cad487de5e0654007686c395b494'.freeze
   end
 end

data/lib/elasticsearch/api.rb

@@ -71,6 +71,7 @@ module Elasticsearch
                       :migration,
                       :machine_learning,
                       :nodes,
+                      :project,
                       :query_rules,
                       :search_application,
                       :searchable_snapshots,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-api
 version: !ruby/object:Gem::Version
-  version: 9.1.2
+  version: 9.2.0
 platform: ruby
 authors:
 - Elastic Client Library Maintainers
@@ -454,6 +454,7 @@ files:
 - 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
+- lib/elasticsearch/api/actions/indices/get_data_stream_mappings.rb
 - lib/elasticsearch/api/actions/indices/get_data_stream_options.rb
 - lib/elasticsearch/api/actions/indices/get_data_stream_settings.rb
 - lib/elasticsearch/api/actions/indices/get_field_mapping.rb
@@ -469,6 +470,7 @@ files:
 - lib/elasticsearch/api/actions/indices/promote_data_stream.rb
 - lib/elasticsearch/api/actions/indices/put_alias.rb
 - lib/elasticsearch/api/actions/indices/put_data_lifecycle.rb
+- lib/elasticsearch/api/actions/indices/put_data_stream_mappings.rb
 - lib/elasticsearch/api/actions/indices/put_data_stream_options.rb
 - lib/elasticsearch/api/actions/indices/put_data_stream_settings.rb
 - lib/elasticsearch/api/actions/indices/put_index_template.rb
@@ -497,6 +499,7 @@ files:
 - lib/elasticsearch/api/actions/inference/get.rb
 - lib/elasticsearch/api/actions/inference/inference.rb
 - lib/elasticsearch/api/actions/inference/put.rb
+- lib/elasticsearch/api/actions/inference/put_ai21.rb
 - lib/elasticsearch/api/actions/inference/put_alibabacloud.rb
 - lib/elasticsearch/api/actions/inference/put_amazonbedrock.rb
 - lib/elasticsearch/api/actions/inference/put_amazonsagemaker.rb
@@ -504,6 +507,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_contextualai.rb
 - lib/elasticsearch/api/actions/inference/put_custom.rb
 - lib/elasticsearch/api/actions/inference/put_deepseek.rb
 - lib/elasticsearch/api/actions/inference/put_elasticsearch.rb
@@ -512,6 +516,7 @@ files:
 - lib/elasticsearch/api/actions/inference/put_googlevertexai.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_openai.rb
 - lib/elasticsearch/api/actions/inference/put_voyageai.rb
@@ -631,6 +636,7 @@ files:
 - lib/elasticsearch/api/actions/nodes/usage.rb
 - lib/elasticsearch/api/actions/open_point_in_time.rb
 - lib/elasticsearch/api/actions/ping.rb
+- lib/elasticsearch/api/actions/project/tags.rb
 - lib/elasticsearch/api/actions/put_script.rb
 - lib/elasticsearch/api/actions/query_rules/delete_rule.rb
 - lib/elasticsearch/api/actions/query_rules/delete_ruleset.rb
@@ -698,6 +704,7 @@ files:
 - lib/elasticsearch/api/actions/security/get_service_accounts.rb
 - lib/elasticsearch/api/actions/security/get_service_credentials.rb
 - lib/elasticsearch/api/actions/security/get_settings.rb
+- lib/elasticsearch/api/actions/security/get_stats.rb
 - lib/elasticsearch/api/actions/security/get_token.rb
 - lib/elasticsearch/api/actions/security/get_user.rb
 - lib/elasticsearch/api/actions/security/get_user_privileges.rb
@@ -834,7 +841,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.1
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Ruby API for Elasticsearch.
 test_files: []