elasticsearch-api 9.0.4 → 9.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f0aa9e30a0e847295df3270d170fffbd1d05e6ba53e2e0a682aa8484548a442
-  data.tar.gz: cf39c5f3a6a72c68b0a071c9c725477ba49bd5566b4a4a5b398cc10f4a019cd0
+  metadata.gz: 33f62431eebf3e1b094974f355ccbe95fb948639b2f1e09f5aa6b641d0e5cfe2
+  data.tar.gz: 21a94c747bb929d7594dafbc19e76d748ff04ff7191c42465761805bb17124fb
 SHA512:
-  metadata.gz: 6387667706d03c482f6ab12ef05a4fcd6182b85b10aab9e300256737b63755012ad48b663eb9aff1c56755515108673b83e57b018883c1310765b8decf2b3e96
-  data.tar.gz: 9e54a5e9db891754d0cab10c3729d918d42e92cc289e4bf8fbf5fd9f589879f004e677570805aa54d0f33d663ebd8eb1811be1dec48a701d123397d1f9f26442
+  metadata.gz: '09a46b80b6c651891f03232088a30f3eea8ca58cee618369774dc5472ef5260a9fa74594bbd7abef2c0413da78002d8069774134de9b7aeaf234c79a4cb935db'
+  data.tar.gz: 47b0605b9213d4dd72311043a9e275e656f122f4c18bebc90a5989706a045b432afef0f089285e57cb9e4ce55e469ed82c7c8c983698a8b86ccf50145ee9f111

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

@@ -78,6 +78,7 @@ module Elasticsearch
       # * JavaScript: Check out `client.helpers.*`
       # * .NET: Check out `BulkAllObservable`
       # * PHP: Check out bulk indexing.
+      # * Ruby: Check out `Elasticsearch::Helpers::BulkHelper`
       # **Submitting bulk requests with cURL**
       # If you're providing text file input to `curl`, you must use the `--data-binary` flag instead of plain `-d`.
       # The latter doesn't preserve newlines. For example:
@@ -186,9 +187,7 @@ module Elasticsearch
                     body
                   end
 
-        headers.merge!({
-                         'Content-Type' => 'application/vnd.elasticsearch+x-ndjson; compatible-with=9'
-                       })
+        Utils.update_ndjson_headers!(headers, transport.options.dig(:transport_options, :headers))
         Elasticsearch::API::Response.new(
           perform_request(method, path, params, payload, headers, request_opts)
         )

data/lib/elasticsearch/api/actions/cat/aliases.rb

@@ -28,7 +28,7 @@ module Elasticsearch
         # IMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.
         #
         # @option arguments [String, Array<String>] :name A comma-separated list of aliases to retrieve. Supports wildcards (`*`).  To retrieve all aliases, omit this parameter or use `*` or `_all`.
-        # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
+        # @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
         # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
         #  Sorting defaults to ascending and can be changed by setting `:asc`
         #  or `:desc` as a suffix to the column name.

data/lib/elasticsearch/api/actions/cat/allocation.rb

@@ -28,7 +28,7 @@ module Elasticsearch
         #
         # @option arguments [String, Array] :node_id A comma-separated list of node identifiers or names used to limit the returned information.
         # @option arguments [String] :bytes The unit used to display byte values.
-        # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
+        # @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
         # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
         #  Sorting defaults to ascending and can be changed by setting `:asc`
         #  or `:desc` as a suffix to the column name.

data/lib/elasticsearch/api/actions/cat/component_templates.rb

@@ -31,7 +31,7 @@ module Elasticsearch
         # @option arguments [String] :name The name of the component template.
         #  It accepts wildcard expressions.
         #  If it is omitted, all component templates are returned.
-        # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
+        # @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
         # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
         #  Sorting defaults to ascending and can be changed by setting `:asc`
         #  or `:desc` as a suffix to the column name.

data/lib/elasticsearch/api/actions/cat/count.rb

@@ -31,7 +31,7 @@ module Elasticsearch
         # @option arguments [String, Array] :index A comma-separated list of data streams, indices, and aliases used to limit the request.
         #  It supports wildcards (`*`).
         #  To target all data streams and indices, omit this parameter or use `*` or `_all`.
-        # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
+        # @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
         # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
         #  Sorting defaults to ascending and can be changed by setting `:asc`
         #  or `:desc` as a suffix to the column name.

data/lib/elasticsearch/api/actions/cat/fielddata.rb

@@ -30,7 +30,7 @@ module Elasticsearch
         # @option arguments [String, Array<String>] :fields Comma-separated list of fields used to limit returned information.
         #  To retrieve all fields, omit this parameter.
         # @option arguments [String] :bytes The unit used to display byte values.
-        # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
+        # @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
         # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
         #  Sorting defaults to ascending and can be changed by setting `:asc`
         #  or `:desc` as a suffix to the column name.

data/lib/elasticsearch/api/actions/esql/async_query.rb

@@ -30,7 +30,8 @@ module Elasticsearch
         #  It is valid only for the CSV format.
         # @option arguments [Boolean] :drop_null_columns Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results.
         #  If `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns.
-        # @option arguments [String] :format A short version of the Accept header, for example `json` or `yaml`.
+        # @option arguments [String] :format A short version of the Accept header, e.g. json, yaml.`csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response.For async requests, nothing will be returned if the async query doesn't finish within the timeout.
+        #  The query ID and running status are available in the `X-Elasticsearch-Async-Id` and `X-Elasticsearch-Async-Is-Running` HTTP headers of the response, respectively.
         # @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/esql/query.rb

@@ -28,7 +28,7 @@ module Elasticsearch
         # minor version, meaning that your referencing code may break when this
         # library is upgraded.
         #
-        # @option arguments [String] :format A short version of the Accept header, e.g. json, yaml.
+        # @option arguments [String] :format A short version of the Accept header, e.g. json, yaml.`csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response.
         # @option arguments [String] :delimiter The character to use between values within a CSV row. Only valid for the CSV format.
         # @option arguments [Boolean] :drop_null_columns Should columns that are entirely `null` be removed from the `columns` and `values` portion of the results?
         #  Defaults to `false`. If `true` then the response will include an extra section under the name `all_columns` which has the name of all columns.

data/lib/elasticsearch/api/actions/fleet/msearch.rb

@@ -108,9 +108,7 @@ module Elasticsearch
             payload = 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/indices/put_mapping.rb

@@ -32,7 +32,7 @@ module Elasticsearch
         # - Update supported mapping parameters
         # - Change a field's mapping using reindexing
         # - Rename a field using a field alias
-        # Learn how to use the update mapping API with practical examples in the {https://www.elastic.co/docs//manage-data/data-store/mapping/update-mappings-examples Update mapping API examples} guide.
+        # Learn how to use the update mapping API with practical examples in the {https://www.elastic.co/docs/manage-data/data-store/mapping/update-mappings-examples Update mapping API examples} guide.
         #
         # @option arguments [String, Array] :index A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices. (*Required*)
         # @option arguments [Boolean] :allow_no_indices If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.

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

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

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

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

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

@@ -51,6 +51,11 @@ 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, which can be used via the task management API to monitor, debug, or cancel the task. 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.

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

@@ -0,0 +1,50 @@
+# 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
+        # Sets a cluster wide upgrade_mode setting that prepares transform indices for an upgrade.
+        #
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/transform-set-upgrade-mode.html
+        #
+        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 = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

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.0.4'.freeze
-    ES_SPECIFICATION_COMMIT = '6a749236ec86e65b50e31dc888c727c0aede67a3'.freeze
+    VERSION = '9.0.5'.freeze
+    ES_SPECIFICATION_COMMIT = '941744bd0826657988ca8f9a336795092b3dbb9b'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-api
 version: !ruby/object:Gem::Version
-  version: 9.0.4
+  version: 9.0.5
 platform: ruby
 authors:
 - Elastic Client Library Maintainers
@@ -771,6 +771,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