elasticsearch-api 9.1.3 → 9.2.0

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

@@ -51,8 +51,8 @@ module Elasticsearch
       # @option arguments [Integer] :batched_reduce_size The number of shard results that should be reduced at once on the coordinating node.
       #  If the potential number of shards in the request can be large, this value should be used as a protection mechanism to reduce the memory overhead per search request. Server default: 512.
       # @option arguments [Boolean] :ccs_minimize_roundtrips If `true`, network round-trips between the coordinating node and the remote clusters are minimized when running cross-cluster search (CCS) requests. Server default: true.
-      # @option arguments [String] :default_operator The default operator for the 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 the 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 a default when 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>] :docvalue_fields A comma-separated list of fields to return as the docvalue representation of a field for each hit.
@@ -84,6 +84,14 @@ module Elasticsearch
       #  - The request targets more than 128 shards.
       #  - The request targets one or more read-only index.
       #  - The primary sort of the query targets an indexed field.
+      # @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] :request_cache If `true`, the caching of search results is enabled for requests where `size` is `0`.
       #  It defaults to index level settings.
       # @option arguments [String] :routing A custom value that is used to route operations to a specific shard.
@@ -129,6 +137,7 @@ module Elasticsearch
       # @option arguments [String, Array<String>] :_source_excludes A comma-separated list of source fields to exclude from the response.
       #  You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.
       #  If the `_source` parameter is `false`, this parameter is ignored.
+      # @option arguments [Boolean] :_source_exclude_vectors Whether vectors should be excluded from _source
       # @option arguments [String, Array<String>] :_source_includes A comma-separated list of source fields to include in the response.
       #  If this parameter is specified, only these source fields are returned.
       #  You can exclude fields from this subset using the `_source_excludes` query parameter.

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

@@ -115,6 +115,14 @@ module Elasticsearch
       #  each feature represents a geotile_grid cell. If 'grid' each feature is a Polygon
       #  of the cells bounding box. If 'point' each feature is a Point that is the centroid
       #  of the cell. Server default: grid.
+      # @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 [Integer] :size Maximum number of features to return in the hits layer. Accepts 0-10000.
       #  If 0, results don't include the hits layer. Server default: 10000.
       # @option arguments [Boolean, Integer] :track_total_hits The number of hits matching the query to count accurately.

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

@@ -38,6 +38,14 @@ module Elasticsearch
       # @option arguments [String] :preference The node or shard the operation should be performed on.
       #  It is random by default.
       # @option arguments [Boolean] :profile If `true`, the query execution is profiled.
+      # @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 [String] :routing A custom value used to route operations to a specific shard.
       # @option arguments [Time] :scroll Specifies how long a consistent view of the index
       #  should be maintained for scrolled search.

data/lib/elasticsearch/api/actions/security/get_stats.rb

@@ -0,0 +1,62 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
+module Elasticsearch
+  module API
+    module Security
+      module Actions
+        # Get security stats.
+        # Gather security usage statistics from all node(s) within the cluster.
+        #
+        # @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/docs/api/doc/elasticsearch/operation/operation-security-get-stats
+        #
+        def get_stats(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'security.get_stats' }
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = '_security/stats'
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/simulate/ingest.rb

@@ -45,6 +45,10 @@ module Elasticsearch
         #  If you specify this parameter in the request path, it is used for any documents that do not explicitly specify an index argument.
         # @option arguments [String] :pipeline The pipeline to use as the default pipeline.
         #  This value can be used to override the default pipeline of the index.
+        # @option arguments [String] :merge_type The mapping merge type if mapping overrides are being provided in mapping_addition.
+        #  The allowed values are one of index or template.
+        #  The index option merges mappings the way they would be merged into an existing index.
+        #  The template option merges mappings the way they would be merged into a template. Server default: index.
         # @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/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/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/status.rb

@@ -29,7 +29,7 @@ module Elasticsearch
         # to fix any issues, but experimental features are not subject to the
         # support SLA of official GA features.
         #
-        # @option arguments [String] :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] :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

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

@@ -17,7 +17,7 @@
 
 module Elasticsearch
   module API
-    VERSION = '9.1.3'.freeze
-    ES_SPECIFICATION_COMMIT = 'ab308fbed818e33443a905ef54a3e2ee7333c11a'.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.3
+  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