elasticsearch-api 9.1.1 → 9.1.3

data/lib/elasticsearch/api/actions/query_rules/list_rulesets.rb

@@ -26,7 +26,7 @@ module Elasticsearch
         # Get summarized information about the query rulesets.
         #
         # @option arguments [Integer] :from The offset from the first result to fetch. Server default: 0.
-        # @option arguments [Integer] :size The maximum number of results to retrieve.
+        # @option arguments [Integer] :size The maximum number of results to retrieve. Server default: 100.
         # @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/reindex.rb

@@ -51,12 +51,17 @@ module Elasticsearch
       # In this case, the response includes a count of the version conflicts that were encountered.
       # Note that the handling of other error types is unaffected by the `conflicts` property.
       # Additionally, if you opt to count version conflicts, the operation could attempt to reindex more documents from the source than `max_docs` until it has successfully indexed `max_docs` documents into the target or it has gone through every document in the source query.
+      # It's recommended to reindex on indices with a green status. Reindexing can fail when a node shuts down or crashes.
+      # * When requested with `wait_for_completion=true` (default), the request fails if the node shuts down.
+      # * When requested with `wait_for_completion=false`, a task id is returned, for use with the task management APIs. The task may disappear or fail if the node shuts down.
+      # When retrying a failed reindex operation, it might be necessary to set `conflicts=proceed` or to first delete the partial destination index.
+      # Additionally, dry runs, checking disk space, and fetching index recovery information can help address the root cause.
       # Refer to the linked documentation for examples of how to reindex documents.
       #
       # @option arguments [Boolean] :refresh If `true`, the request refreshes affected shards to make this operation visible to search.
       # @option arguments [Float] :requests_per_second The throttle for this request in sub-requests per second.
       #  By default, there is no throttle. Server default: -1.
-      # @option arguments [Time] :scroll The period of time that a consistent view of the index should be maintained for scrolled search.
+      # @option arguments [Time] :scroll The period of time that a consistent view of the index should be maintained for scrolled search. Server default: 5m.
       # @option arguments [Integer, String] :slices The number of slices this task should be divided into.
       #  It defaults to one slice, which means the task isn't sliced into subtasks.Reindex supports sliced scroll to parallelize the reindexing process.
       #  This parallelization can improve efficiency and provide a convenient way to break the request down into smaller parts.NOTE: Reindexing from remote clusters does not support manual or automatic slicing.If set to `auto`, Elasticsearch chooses the number of slices to use.

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

@@ -107,7 +107,7 @@ module Elasticsearch
       #  the <zoom>/<x>/<y> tile with wrap_longitude set to false. The resulting
       #  bounding box may be larger than the vector tile.
       # @option arguments [Integer] :extent The size, in pixels, of a side of the tile. Vector tiles are square with equal sides. Server default: 4096.
-      # @option arguments [String] :grid_agg Aggregation used to create a grid for `field`.
+      # @option arguments [String] :grid_agg Aggregation used to create a grid for `field`. Server default: geotile.
       # @option arguments [Integer] :grid_precision Additional zoom levels available through the aggs layer. For example, if <zoom> is 7
       #  and grid_precision is 8, you can zoom in up to level 15. Accepts 0-8. If 0, results
       #  don't include the aggs layer. Server default: 8.

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

@@ -25,7 +25,7 @@ module Elasticsearch
         # Get searchable snapshot statistics.
         #
         # @option arguments [String, Array] :index A comma-separated list of data streams and indices to retrieve statistics for.
-        # @option arguments [String] :level Return stats aggregated at cluster, index or shard level
+        # @option arguments [String] :level Return stats aggregated at cluster, index or shard level Server default: indices.
         # @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/security/get_settings.rb

@@ -30,7 +30,7 @@ module Elasticsearch
         # * `index.number_of_replicas`
         #
         # @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.
+        #  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/security/update_settings.rb

@@ -29,7 +29,7 @@ module Elasticsearch
         # This API does not yet support configuring the settings for indices before they are in use.
         #
         # @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/actions/snapshot/get_repository.rb

@@ -30,7 +30,7 @@ module Elasticsearch
         #  If `false`, the request gets information from the master node.
         # @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: to 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

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/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 [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 [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/text_structure/find_structure.rb

@@ -136,9 +136,7 @@ module Elasticsearch
                       body
                     end
 
-          headers.merge!({
-                           'Content-Type' => 'application/vnd.elasticsearch+x-ndjson; compatible-with=9'
-                         })
+          Utils.update_ndjson_headers!(headers, client.transport.options.dig(:transport_options, :headers))
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, payload, headers, request_opts)
           )

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/transform/set_upgrade_mode.rb

@@ -0,0 +1,77 @@
+# 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 Transform
+      module Actions
+        # Set upgrade_mode for transform indices.
+        # Sets a cluster wide upgrade_mode setting that prepares transform
+        # indices for an upgrade.
+        # When upgrading your cluster, in some circumstances you must restart your
+        # nodes and reindex your transform indices. In those circumstances,
+        # there must be no transforms running. You can close the transforms,
+        # do the upgrade, then open all the transforms again. Alternatively,
+        # you can use this API to temporarily halt tasks associated with the transforms
+        # and prevent new transforms from opening. You can also use this API
+        # during upgrades that do not require you to reindex your transform
+        # indices, though stopping transforms is not a requirement in that case.
+        # You can see the current value for the upgrade_mode setting by using the get
+        # transform info API.
+        #
+        # @option arguments [Boolean] :enabled When `true`, it enables `upgrade_mode` which temporarily halts all
+        #  transform tasks and prohibits new transform tasks from
+        #  starting.
+        # @option arguments [Time] :timeout The time to wait for the request to be completed. 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/docs/api/doc/elasticsearch/operation/operation-transform-set-upgrade-mode
+        #
+        def set_upgrade_mode(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'transform.set_upgrade_mode' }
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = '_transform/set_upgrade_mode'
+          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/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/utils.rb

@@ -177,6 +177,21 @@ module Elasticsearch
         end
       end
 
+      # Updates ndjson headers for msearch, bulk, and others
+      #
+      def update_ndjson_headers!(headers, client_headers)
+        current_content = client_headers.keys.find { |c| c.match?(/content-?_?type/i) } || 'content-type'
+        current_accept = client_headers.keys.find { |c| c.match?(/accept/i) } || 'accept'
+        version = client_headers[current_content].match(/compatible-with=([0-9]+)/)[1] || 9
+
+        headers.merge!(
+          {
+            current_content => "application/vnd.elasticsearch+x-ndjson; compatible-with=#{version}",
+            current_accept => "application/vnd.elasticsearch+x-ndjson; compatible-with=#{version}"
+          }
+        )
+      end
+
       extend self
     end
   end

data/lib/elasticsearch/api/version.rb

@@ -17,7 +17,7 @@
 
 module Elasticsearch
   module API
-    VERSION = '9.1.1'.freeze
-    ES_SPECIFICATION_COMMIT = '569f8b3768762075a47e5fa16a694b41cbc90a34'.freeze
+    VERSION = '9.1.3'.freeze
+    ES_SPECIFICATION_COMMIT = 'ab308fbed818e33443a905ef54a3e2ee7333c11a'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-api
 version: !ruby/object:Gem::Version
-  version: 9.1.1
+  version: 9.1.3
 platform: ruby
 authors:
 - Elastic Client Library Maintainers
@@ -785,6 +785,7 @@ files:
 - lib/elasticsearch/api/actions/transform/put_transform.rb
 - lib/elasticsearch/api/actions/transform/reset_transform.rb
 - lib/elasticsearch/api/actions/transform/schedule_now_transform.rb
+- lib/elasticsearch/api/actions/transform/set_upgrade_mode.rb
 - lib/elasticsearch/api/actions/transform/start_transform.rb
 - lib/elasticsearch/api/actions/transform/stop_transform.rb
 - lib/elasticsearch/api/actions/transform/update_transform.rb
@@ -833,7 +834,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: []