elasticsearch-api 8.18.0 → 9.0.1

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

@@ -15,23 +15,32 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# 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
-        # Retrieves usage information for transforms.
+        # Get transform stats.
+        # Get usage information for transforms.
         #
-        # @option arguments [String] :transform_id The id of the transform for which to get stats. '_all' or '*' implies all transforms
-        # @option arguments [Number] :from skips a number of transform stats, defaults to 0
-        # @option arguments [Number] :size specifies a max number of transform stats to get, defaults to 100
+        # @option arguments [String, Array<String>] :transform_id Identifier for the transform. It can be a transform identifier or a
+        #  wildcard expression. You can get information for all transforms by using
+        #  +_all+, by specifying +*+ as the +<transform_id>+, or by omitting the
+        #  +<transform_id>+. (*Required*)
+        # @option arguments [Boolean] :allow_no_match Specifies what to do when the request:
+        #  - Contains wildcard expressions and there are no transforms that match.
+        #  - Contains the _all string or no identifiers and there are no matches.
+        #  - Contains wildcard expressions and there are only partial matches.
+        #  If this parameter is false, the request returns a 404 status code when
+        #  there are no matches or only partial matches. Server default: true.
+        # @option arguments [Integer] :from Skips the specified number of transforms. Server default: 0.
+        # @option arguments [Integer] :size Specifies the maximum number of transforms to obtain. Server default: 100.
         # @option arguments [Time] :timeout Controls the time to wait for the stats
-        # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-transform-stats.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-get-transform-stats
         #
         def get_transform_stats(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'transform.get_transform_stats' }
@@ -51,7 +60,7 @@ module Elasticsearch
           _transform_id = arguments.delete(:transform_id)
 
           method = Elasticsearch::API::HTTP_GET
-          path   = "_transform/#{Utils.__listify(_transform_id)}/_stats"
+          path   = "_transform/#{Utils.listify(_transform_id)}/_stats"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,21 +15,27 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# 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
-        # Previews a transform.
+        # Preview a transform.
+        # Generates a preview of the results that you will get when you create a transform with the same configuration.
+        # It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also
+        # generates a list of mappings and settings for the destination index. These values are determined based on the field
+        # types of the source index and the transform aggregations.
         #
-        # @option arguments [String] :transform_id The id of the transform to preview.
-        # @option arguments [Time] :timeout Controls the time to wait for the preview
+        # @option arguments [String] :transform_id Identifier for the transform to preview. If you specify this path parameter, you cannot provide transform
+        #  configuration details in the request body.
+        # @option arguments [Time] :timeout 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 [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The definition for the transform to preview
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/preview-transform.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-preview-transform
         #
         def preview_transform(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'transform.preview_transform' }
@@ -52,11 +58,11 @@ module Elasticsearch
                      Elasticsearch::API::HTTP_GET
                    end
 
-          path = if _transform_id
-                   "_transform/#{Utils.__listify(_transform_id)}/_preview"
-                 else
-                   '_transform/_preview'
-                 end
+          path   = if _transform_id
+                     "_transform/#{Utils.listify(_transform_id)}/_preview"
+                   else
+                     '_transform/_preview'
+                   end
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,22 +15,44 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# 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
-        # Instantiates a transform.
+        # Create a transform.
+        # Creates a transform.
+        # A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as
+        # a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a
+        # unique row per entity.
+        # You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If
+        # you choose to use the pivot method for your transform, the entities are defined by the set of +group_by+ fields in
+        # the pivot object. If you choose to use the latest method, the entities are defined by the +unique_key+ field values
+        # in the latest object.
+        # You must have +create_index+, +index+, and +read+ privileges on the destination index and +read+ and
+        # +view_index_metadata+ privileges on the source indices. When Elasticsearch security features are enabled, the
+        # transform remembers which roles the user that created it had at the time of creation and uses those same roles. If
+        # those roles do not have the required privileges on the source and destination indices, the transform fails when it
+        # attempts unauthorized operations.
+        # NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any
+        # +.transform-internal*+ indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do
+        # not give users any privileges on +.transform-internal*+ indices. If you used transforms prior to 7.5, also do not
+        # give users any privileges on +.data-frame-internal*+ indices.
         #
-        # @option arguments [String] :transform_id The id of the new transform.
-        # @option arguments [Boolean] :defer_validation If validations should be deferred until transform starts, defaults to false.
-        # @option arguments [Time] :timeout Controls the time to wait for the transform to start
+        # @option arguments [String] :transform_id Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9),
+        #  hyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters. (*Required*)
+        # @option arguments [Boolean] :defer_validation When the transform is created, a series of validations occur to ensure its success. For example, there is a
+        #  check for the existence of the source indices and a check that the destination index is not part of the source
+        #  index pattern. You can use this parameter to skip the checks, for example when the source index does not exist
+        #  until after the transform is created. The validations are always run when you start the transform, however, with
+        #  the exception of privilege checks.
+        # @option arguments [Time] :timeout 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 [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The transform definition (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-transform.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-put-transform
         #
         def put_transform(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'transform.put_transform' }
@@ -51,7 +73,7 @@ module Elasticsearch
           _transform_id = arguments.delete(:transform_id)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_transform/#{Utils.__listify(_transform_id)}"
+          path   = "_transform/#{Utils.listify(_transform_id)}"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,21 +15,25 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# 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
-        # Resets an existing transform.
+        # Reset a transform.
+        # Before you can reset it, you must stop it; alternatively, use the +force+ query parameter.
+        # If the destination index was created by the transform, it is deleted.
         #
-        # @option arguments [String] :transform_id The id of the transform to reset
-        # @option arguments [Boolean] :force When `true`, the transform is reset regardless of its current state. The default value is `false`, meaning that the transform must be `stopped` before it can be reset.
-        # @option arguments [Time] :timeout Controls the time to wait for the transform to reset
+        # @option arguments [String] :transform_id Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9),
+        #  hyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters. (*Required*)
+        # @option arguments [Boolean] :force If this value is +true+, the transform is reset regardless of its current state. If it's +false+, the transform
+        #  must be stopped before it can be reset.
+        # @option arguments [Time] :timeout 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 [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/reset-transform.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-reset-transform
         #
         def reset_transform(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'transform.reset_transform' }
@@ -49,7 +53,7 @@ module Elasticsearch
           _transform_id = arguments.delete(:transform_id)
 
           method = Elasticsearch::API::HTTP_POST
-          path   = "_transform/#{Utils.__listify(_transform_id)}/_reset"
+          path   = "_transform/#{Utils.listify(_transform_id)}/_reset"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,20 +15,25 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# 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
-        # Schedules now a transform.
+        # Schedule a transform to start now.
+        # Instantly run a transform to process data.
+        # If you run this API, the transform will process the new data instantly,
+        # without waiting for the configured frequency interval. After the API is called,
+        # the transform will be processed again at +now + frequency+ unless the API
+        # is called again in the meantime.
         #
-        # @option arguments [String] :transform_id The id of the transform. (*Required*)
-        # @option arguments [Time] :timeout Controls the time to wait for the scheduling to take place
+        # @option arguments [String] :transform_id Identifier for the transform. (*Required*)
+        # @option arguments [Time] :timeout Controls the time to wait for the scheduling to take place Server default: 30s.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/schedule-now-transform.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-schedule-now-transform
         #
         def schedule_now_transform(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'transform.schedule_now_transform' }
@@ -48,7 +53,7 @@ module Elasticsearch
           _transform_id = arguments.delete(:transform_id)
 
           method = Elasticsearch::API::HTTP_POST
-          path   = "_transform/#{Utils.__listify(_transform_id)}/_schedule_now"
+          path   = "_transform/#{Utils.listify(_transform_id)}/_schedule_now"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,21 +15,34 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# 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
-        # Starts one or more transforms.
+        # Start a transform.
+        # When you start a transform, it creates the destination index if it does not already exist. The +number_of_shards+ is
+        # set to +1+ and the +auto_expand_replicas+ is set to +0-1+. If it is a pivot transform, it deduces the mapping
+        # definitions for the destination index from the source indices and the transform aggregations. If fields in the
+        # destination index are derived from scripts (as in the case of +scripted_metric+ or +bucket_script+ aggregations),
+        # the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce
+        # mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you
+        # start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings
+        # in a pivot transform.
+        # When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you
+        # created the transform, they occur when you start the transform—​with the exception of privilege checks. When
+        # Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the
+        # time of creation and uses those same roles. If those roles do not have the required privileges on the source and
+        # destination indices, the transform fails when it attempts unauthorized operations.
         #
-        # @option arguments [String] :transform_id The id of the transform to start
-        # @option arguments [String] :from Restricts the set of transformed entities to those changed after this time
-        # @option arguments [Time] :timeout Controls the time to wait for the transform to start
+        # @option arguments [String] :transform_id Identifier for the transform. (*Required*)
+        # @option arguments [Time] :timeout 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 [String] :from Restricts the set of transformed entities to those changed after this time. Relative times like now-30d are supported. Only applicable for continuous transforms.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/start-transform.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-start-transform
         #
         def start_transform(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'transform.start_transform' }
@@ -49,7 +62,7 @@ module Elasticsearch
           _transform_id = arguments.delete(:transform_id)
 
           method = Elasticsearch::API::HTTP_POST
-          path   = "_transform/#{Utils.__listify(_transform_id)}/_start"
+          path   = "_transform/#{Utils.listify(_transform_id)}/_start"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,24 +15,33 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# 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
+        # Stop transforms.
         # Stops one or more transforms.
         #
-        # @option arguments [String] :transform_id The id of the transform to stop
-        # @option arguments [Boolean] :force Whether to force stop a failed transform or not. Default to false
-        # @option arguments [Boolean] :wait_for_completion Whether to wait for the transform to fully stop before returning or not. Default to false
-        # @option arguments [Time] :timeout Controls the time to wait until the transform has stopped. Default to 30 seconds
-        # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)
-        # @option arguments [Boolean] :wait_for_checkpoint Whether to wait for the transform to reach a checkpoint before stopping. Default to false
+        # @option arguments [String] :transform_id Identifier for the transform. To stop multiple transforms, use a comma-separated list or a wildcard expression.
+        #  To stop all transforms, use +_all+ or +*+ as the identifier. (*Required*)
+        # @option arguments [Boolean] :allow_no_match Specifies what to do when the request: contains wildcard expressions and there are no transforms that match;
+        #  contains the +_all+ string or no identifiers and there are no matches; contains wildcard expressions and there
+        #  are only partial matches.If it is true, the API returns a successful acknowledgement message when there are no matches. When there are
+        #  only partial matches, the API stops the appropriate transforms.If it is false, the request returns a 404 status code when there are no matches or only partial matches. Server default: true.
+        # @option arguments [Boolean] :force If it is true, the API forcefully stops the transforms.
+        # @option arguments [Time] :timeout Period to wait for a response when +wait_for_completion+ is +true+. If no response is received before the
+        #  timeout expires, the request returns a timeout exception. However, the request continues processing and
+        #  eventually moves the transform to a STOPPED state. Server default: 30s.
+        # @option arguments [Boolean] :wait_for_checkpoint If it is true, the transform does not completely stop until the current checkpoint is completed. If it is false,
+        #  the transform stops as soon as possible.
+        # @option arguments [Boolean] :wait_for_completion If it is true, the API blocks until the indexer state completely stops. If it is false, the API returns
+        #  immediately and the indexer is stopped asynchronously in the background.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/stop-transform.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-stop-transform
         #
         def stop_transform(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'transform.stop_transform' }
@@ -52,7 +61,7 @@ module Elasticsearch
           _transform_id = arguments.delete(:transform_id)
 
           method = Elasticsearch::API::HTTP_POST
-          path   = "_transform/#{Utils.__listify(_transform_id)}/_stop"
+          path   = "_transform/#{Utils.listify(_transform_id)}/_stop"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,22 +15,31 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# 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
+        # Update a transform.
         # Updates certain properties of a transform.
+        # All updated properties except +description+ do not take effect until after the transform starts the next checkpoint,
+        # thus there is data consistency in each checkpoint. To use this API, you must have +read+ and +view_index_metadata+
+        # privileges for the source indices. You must also have +index+ and +read+ privileges for the destination index. When
+        # Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the
+        # time of update and runs with those privileges.
         #
-        # @option arguments [String] :transform_id The id of the transform. (*Required*)
-        # @option arguments [Boolean] :defer_validation If validations should be deferred until transform starts, defaults to false.
-        # @option arguments [Time] :timeout Controls the time to wait for the update
+        # @option arguments [String] :transform_id Identifier for the transform. (*Required*)
+        # @option arguments [Boolean] :defer_validation When true, deferrable validations are not run. This behavior may be
+        #  desired if the source index does not exist until after the transform is
+        #  created.
+        # @option arguments [Time] :timeout 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 [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The update transform definition (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-transform.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-update-transform
         #
         def update_transform(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'transform.update_transform' }
@@ -51,7 +60,7 @@ module Elasticsearch
           _transform_id = arguments.delete(:transform_id)
 
           method = Elasticsearch::API::HTTP_POST
-          path   = "_transform/#{Utils.__listify(_transform_id)}/_update"
+          path   = "_transform/#{Utils.listify(_transform_id)}/_update"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,20 +15,32 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# 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
-        # Upgrades all transforms.
+        # Upgrade all transforms.
+        # Transforms are compatible across minor versions and between supported major versions.
+        # However, over time, the format of transform configuration information may change.
+        # This API identifies transforms that have a legacy configuration format and upgrades them to the latest version.
+        # It also cleans up the internal data structures that store the transform state and checkpoints.
+        # The upgrade does not affect the source and destination indices.
+        # The upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged.
+        # If a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue.
+        # Resolve the issue then re-run the process again.
+        # A summary is returned when the upgrade is finished.
+        # To ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster.
+        # You may want to perform a recent cluster backup prior to the upgrade.
         #
-        # @option arguments [Boolean] :dry_run Whether to only check for updates but don't execute
-        # @option arguments [Time] :timeout Controls the time to wait for the upgrade
+        # @option arguments [Boolean] :dry_run When true, the request checks for updates but does not run them.
+        # @option arguments [Time] :timeout 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 [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/upgrade-transforms.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-upgrade-transforms
         #
         def upgrade_transforms(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'transform.upgrade_transforms' }
@@ -36,7 +48,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = nil
+          body = nil
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_transform/_upgrade'

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

@@ -15,38 +15,58 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# 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 Actions
-      # Updates a document with a script or partial document.
+      # Update a document.
+      # Update a document by running a script or passing a partial document.
+      # If the Elasticsearch security features are enabled, you must have the +index+ or +write+ index privilege for the target index or index alias.
+      # The script can update, delete, or skip modifying the document.
+      # The API also supports passing a partial document, which is merged into the existing document.
+      # To fully replace an existing document, use the index API.
+      # This operation:
+      # * Gets the document (collocated with the shard) from the index.
+      # * Runs the specified script.
+      # * Indexes the result.
+      # The document must still be reindexed, but using this API removes some network roundtrips and reduces chances of version conflicts between the GET and the index operation.
+      # The +_source+ field must be enabled to use this API.
+      # In addition to +_source+, you can access the following variables through the +ctx+ map: +_index+, +_type+, +_id+, +_version+, +_routing+, and +_now+ (the current timestamp).
       #
-      # @option arguments [String] :id Document ID
-      # @option arguments [String] :index The name of the index
-      # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the update operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
-      # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return
-      # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field
-      # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field
-      # @option arguments [String] :lang The script language (default: painless)
-      # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (options: true, false, wait_for)
-      # @option arguments [Number] :retry_on_conflict Specify how many times should the operation be retried when a conflict occurs (default: 0)
-      # @option arguments [String] :routing Specific routing value
-      # @option arguments [Time] :timeout Explicit operation timeout
-      # @option arguments [Number] :if_seq_no only perform the update operation if the last operation that has changed the document has the specified sequence number
-      # @option arguments [Number] :if_primary_term only perform the update operation if the last operation that has changed the document has the specified primary term
-      # @option arguments [Boolean] :require_alias When true, requires destination is an alias. Default is false
-      # @option arguments [Boolean] :include_source_on_error True or false if to include the document source in the error message in case of parsing errors. Defaults to true.
+      # @option arguments [String] :id A unique identifier for the document to be updated. (*Required*)
+      # @option arguments [String] :index The name of the target index.
+      #  By default, the index is created automatically if it doesn't exist. (*Required*)
+      # @option arguments [Integer] :if_primary_term Only perform the operation if the document has this primary term.
+      # @option arguments [Integer] :if_seq_no Only perform the operation if the document has this sequence number.
+      # @option arguments [Boolean] :include_source_on_error True or false if to include the document source in the error message in case of parsing errors. Server default: true.
+      # @option arguments [String] :lang The script language. Server default: painless.
+      # @option arguments [String] :refresh If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search.
+      #  If 'wait_for', it waits for a refresh to make this operation visible to search.
+      #  If 'false', it does nothing with refreshes. Server default: false.
+      # @option arguments [Boolean] :require_alias If +true+, the destination must be an index alias.
+      # @option arguments [Integer] :retry_on_conflict The number of times the operation should be retried when a conflict occurs. Server default: 0.
+      # @option arguments [String] :routing A custom value used to route operations to a specific shard.
+      # @option arguments [Time] :timeout The period to wait for the following operations: dynamic mapping updates and waiting for active shards.
+      #  Elasticsearch waits for at least the timeout period before failing.
+      #  The actual wait time could be longer, particularly when multiple waits occur. Server default: 1m.
+      # @option arguments [Integer, String] :wait_for_active_shards The number of copies of each shard that must be active before proceeding with the operation.
+      #  Set to 'all' or any positive integer up to the total number of shards in the index (+number_of_replicas++1).
+      #  The default value of +1+ means it waits for each primary shard to be active. Server default: 1.
+      # @option arguments [Boolean, String, Array<String>] :_source If +false+, source retrieval is turned off.
+      #  You can also specify a comma-separated list of the fields you want to retrieve. Server default: true.
+      # @option arguments [String, Array<String>] :_source_excludes The source fields you want to exclude.
+      # @option arguments [String, Array<String>] :_source_includes The source fields you want to retrieve.
       # @option arguments [Hash] :headers Custom HTTP headers
-      # @option arguments [Hash] :body The request definition requires either `script` or partial `doc` (*Required*)
+      # @option arguments [Hash] :body request body
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-update.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-update
       #
       def update(arguments = {})
         request_opts = { endpoint: arguments[:endpoint] || 'update' }
 
-        defined_params = %i[index id].each_with_object({}) do |variable, set_variables|
+        defined_params = [:index, :id].each_with_object({}) do |variable, set_variables|
           set_variables[variable] = arguments[variable] if arguments.key?(variable)
         end
         request_opts[:defined_params] = defined_params unless defined_params.empty?
@@ -65,11 +85,11 @@ module Elasticsearch
         _index = arguments.delete(:index)
 
         method = Elasticsearch::API::HTTP_POST
-        path   = "#{Utils.__listify(_index)}/_update/#{Utils.__listify(_id)}"
+        path   = "#{Utils.listify(_index)}/_update/#{Utils.listify(_id)}"
         params = Utils.process_params(arguments)
 
         if Array(arguments[:ignore]).include?(404)
-          Utils.__rescue_from_not_found do
+          Utils.rescue_from_not_found do
             Elasticsearch::API::Response.new(
               perform_request(method, path, params, body, headers, request_opts)
             )