elasticsearch-serverless 0.1.0.20231031.pre → 0.2.0

data/lib/elasticsearch-serverless/api/query_rules/put_rule.rb

@@ -0,0 +1,59 @@
+# 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.
+#
+# Auto generated from commit f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch-specification
+#
+module ElasticsearchServerless
+  module API
+    module QueryRules
+      module Actions
+        # Creates or updates a query rule within a query ruleset.
+        #
+        # @option arguments [String] :ruleset_id The unique identifier of the query ruleset containing the rule to be created or updated (*Required*)
+        # @option arguments [String] :rule_id The unique identifier of the query rule within the specified ruleset to be created or updated (*Required*)
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body request body
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/put-query-rule.html
+        #
+        def put_rule(arguments = {})
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+          raise ArgumentError, "Required argument 'ruleset_id' missing" unless arguments[:ruleset_id]
+          raise ArgumentError, "Required argument 'rule_id' missing" unless arguments[:rule_id]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          _ruleset_id = arguments.delete(:ruleset_id)
+
+          _rule_id = arguments.delete(:rule_id)
+
+          method = ElasticsearchServerless::API::HTTP_PUT
+          path   = "_query_rules/#{Utils.listify(_ruleset_id)}/_rule/#{Utils.listify(_rule_id)}"
+          params = {}
+
+          ElasticsearchServerless::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch-serverless/api/{query_ruleset/put.rb → query_rules/put_ruleset.rb}

@@ -20,13 +20,9 @@
 #
 module ElasticsearchServerless
   module API
-    module QueryRuleset
+    module QueryRules
       module Actions
         # Creates or updates a query ruleset.
-        # 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] :ruleset_id The unique identifier of the query ruleset to be created or updated (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
@@ -34,7 +30,7 @@ module ElasticsearchServerless
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/put-query-ruleset.html
         #
-        def put(arguments = {})
+        def put_ruleset(arguments = {})
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
           raise ArgumentError, "Required argument 'ruleset_id' missing" unless arguments[:ruleset_id]
 

data/lib/elasticsearch-serverless/api/rank_eval.rb

@@ -21,7 +21,7 @@
 module ElasticsearchServerless
   module API
     module Actions
-      # Allows to evaluate the quality of ranked search results over a set of typical search queries
+      # Enables you to evaluate the quality of ranked search results over a set of typical search queries.
       #
       # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard (+*+) expressions are supported. To target all data streams and indices in a cluster, omit this parameter or use +_all+ or +*+.
       # @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. This behavior applies even if the request targets other open indices. For example, a request targeting +foo*,bar*+ returns an error if an index starts with +foo+ but no index starts with +bar+. Server default: true.

data/lib/elasticsearch-serverless/api/render_search_template.rb

@@ -21,7 +21,7 @@
 module ElasticsearchServerless
   module API
     module Actions
-      # Allows to use the Mustache language to pre-render a search definition.
+      # Renders a search template as a search request body.
       #
       # @option arguments [String] :id ID of the search template to render. If no +source+ is specified, this or the +id+ request body parameter is required.
       # @option arguments [Hash] :headers Custom HTTP headers

data/lib/elasticsearch-serverless/api/scripts_painless_execute.rb

@@ -21,7 +21,7 @@
 module ElasticsearchServerless
   module API
     module Actions
-      # Allows an arbitrary script to be executed and a result to be returned
+      # Runs a script and returns a result.
       # 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

data/lib/elasticsearch-serverless/api/search.rb

@@ -21,7 +21,9 @@
 module ElasticsearchServerless
   module API
     module Actions
-      # Returns results matching a query.
+      # Returns search hits that match the query defined in the request.
+      # You can provide search queries using the +q+ query string parameter or the request body.
+      # If both are specified, only the query parameter is used.
       #
       # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (+*+). To search all data streams and indices, omit this parameter or use +*+ or +_all+.
       # @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. This behavior applies even if the request targets other open indices. For example, a request targeting +foo*,bar*+ returns an error if an index starts with +foo+ but no index starts with +bar+. Server default: true.
@@ -67,6 +69,7 @@ module ElasticsearchServerless
       # @option arguments [Integer] :size Defines the number of hits to return. By default, you cannot page through more than 10,000 hits using the +from+ and +size+ parameters. To page through more hits, use the +search_after+ parameter. Server default: 10.
       # @option arguments [Integer] :from Starting document offset. Needs to be non-negative. By default, you cannot page through more than 10,000 hits using the +from+ and +size+ parameters. To page through more hits, use the +search_after+ parameter. Server default: 0.
       # @option arguments [String] :sort A comma-separated list of <field>:<direction> pairs.
+      # @option arguments [Boolean] :force_synthetic_source Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index.
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body request body
       #

data/lib/elasticsearch-serverless/api/search_application/get.rb

@@ -22,7 +22,7 @@ module ElasticsearchServerless
   module API
     module SearchApplication
       module Actions
-        # Returns the details about a search application.
+        # Returns the details about a search application
         # This functionality is in Beta and is subject to change. The design and
         # code is less mature than official GA features and is being provided
         # as-is with no warranties. Beta features are not subject to the support

data/lib/elasticsearch-serverless/api/search_application/search.rb

@@ -22,13 +22,14 @@ module ElasticsearchServerless
   module API
     module SearchApplication
       module Actions
-        # Perform a search against a search application
+        # Perform a search against a search application.
         # This functionality is in Beta and is subject to change. The design and
         # code is less mature than official GA features and is being provided
         # as-is with no warranties. Beta features are not subject to the support
         # SLA of official GA features.
         #
         # @option arguments [String] :name The name of the search application to be searched. (*Required*)
+        # @option arguments [Boolean] :typed_keys Determines whether aggregation names are prefixed by their respective types in the response.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
@@ -51,7 +52,7 @@ module ElasticsearchServerless
                    end
 
           path   = "_application/search_application/#{Utils.listify(_name)}/_search"
-          params = {}
+          params = Utils.process_params(arguments)
 
           ElasticsearchServerless::API::Response.new(
             perform_request(method, path, params, body, headers)

data/lib/elasticsearch-serverless/api/search_template.rb

@@ -21,7 +21,7 @@
 module ElasticsearchServerless
   module API
     module Actions
-      # Allows to use the Mustache language to pre-render a search definition.
+      # Runs a search with a search template.
       #
       # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (*).
       # @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. This behavior applies even if the request targets other open indices. For example, a request targeting +foo*,bar*+ returns an error if an index starts with +foo+ but no index starts with +bar+. Server default: true.

data/lib/elasticsearch-serverless/api/security/authenticate.rb

@@ -22,7 +22,9 @@ module ElasticsearchServerless
   module API
     module Security
       module Actions
-        # Enables authentication as a user and retrieve information about the authenticated user.
+        # Enables you to submit a request with a basic auth header to authenticate a user and retrieve information about the authenticated user.
+        # A successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user.
+        # If the user cannot be authenticated, this API returns a 401 status code.
         #
         # @option arguments [Hash] :headers Custom HTTP headers
         #

data/lib/elasticsearch-serverless/api/security/create_api_key.rb

@@ -23,6 +23,9 @@ module ElasticsearchServerless
     module Security
       module Actions
         # Creates an API key for access without requiring basic authentication.
+        # A successful request returns a JSON structure that contains the API key, its unique id, and its name.
+        # If applicable, it also returns expiration information for the API key in milliseconds.
+        # NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.
         #
         # @option arguments [String] :refresh If +true+ (the default) 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+ then do nothing with refreshes.
         # @option arguments [Hash] :headers Custom HTTP headers

data/lib/elasticsearch-serverless/api/security/get_api_key.rb

@@ -23,6 +23,8 @@ module ElasticsearchServerless
     module Security
       module Actions
         # Retrieves information for one or more API keys.
+        # NOTE: If you have only the +manage_own_api_key+ privilege, this API returns only the API keys that you own.
+        # If you have +read_security+, +manage_api_key+ or greater privileges (including +manage_security+), this API returns all API keys regardless of ownership.
         #
         # @option arguments [String] :id An API key id. This parameter cannot be used with any of +name+, +realm_name+ or +username+.
         # @option arguments [String] :name An API key name. This parameter cannot be used with any of +id+, +realm_name+ or +username+. It supports prefix search with wildcard.
@@ -30,6 +32,8 @@ module ElasticsearchServerless
         # @option arguments [String] :realm_name The name of an authentication realm. This parameter cannot be used with either +id+ or +name+ or when +owner+ flag is set to +true+.
         # @option arguments [String] :username The username of a user. This parameter cannot be used with either +id+ or +name+ or when +owner+ flag is set to +true+.
         # @option arguments [Boolean] :with_limited_by Return the snapshot of the owner user's role descriptors associated with the API key. An API key's actual permission is the intersection of its assigned role descriptors and the owner user's role descriptors.
+        # @option arguments [Boolean] :active_only A boolean flag that can be used to query API keys that are currently active. An API key is considered active if it is neither invalidated, nor expired at query time. You can specify this together with other parameters such as +owner+ or +name+. If +active_only+ is false, the response will include both active and inactive (expired or invalidated) keys.
+        # @option arguments [Boolean] :with_profile_uid Determines whether to also retrieve the profile uid, for the API key owner principal, if it exists.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html

data/lib/elasticsearch-serverless/api/security/invalidate_api_key.rb

@@ -23,6 +23,12 @@ module ElasticsearchServerless
     module Security
       module Actions
         # Invalidates one or more API keys.
+        # The +manage_api_key+ privilege allows deleting any API keys.
+        # The +manage_own_api_key+ only allows deleting API keys that are owned by the user.
+        # In addition, with the +manage_own_api_key+ privilege, an invalidation request must be issued in one of the three formats:
+        # - Set the parameter +owner=true+.
+        # - Or, set both +username+ and +realm_name+ to match the user’s identity.
+        # - Or, if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the +ids+ field.
         #
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body

data/lib/elasticsearch-serverless/api/security/query_api_keys.rb

@@ -22,9 +22,11 @@ module ElasticsearchServerless
   module API
     module Security
       module Actions
-        # Retrieves information for API keys using a subset of query DSL
+        # Retrieves information for API keys in a paginated manner. You can optionally filter the results with a query.
         #
-        # @option arguments [Boolean] :with_limited_by Return the snapshot of the owner user's role descriptors associated with the API key.  An API key's actual permission is the intersection of its assigned role descriptors and the owner user's role descriptors.
+        # @option arguments [Boolean] :with_limited_by Return the snapshot of the owner user's role descriptors associated with the API key. An API key's actual permission is the intersection of its assigned role descriptors and the owner user's role descriptors.
+        # @option arguments [Boolean] :with_profile_uid Determines whether to also retrieve the profile uid, for the API key owner principal, if it exists.
+        # @option arguments [Boolean] :typed_keys Determines whether aggregation names are prefixed by their respective types in the response.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #

data/lib/elasticsearch-serverless/api/security/update_api_key.rb

@@ -0,0 +1,66 @@
+# 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.
+#
+# Auto generated from commit f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch-specification
+#
+module ElasticsearchServerless
+  module API
+    module Security
+      module Actions
+        # Updates attributes of an existing API key.
+        # Users can only update API keys that they created or that were granted to them.
+        # Use this API to update API keys created by the create API Key or grant API Key APIs.
+        # If you need to apply the same update to many API keys, you can use bulk update API Keys to reduce overhead.
+        # It’s not possible to update expired API keys, or API keys that have been invalidated by invalidate API Key.
+        # This API supports updates to an API key’s access scope and metadata.
+        # The access scope of an API key is derived from the +role_descriptors+ you specify in the request, and a snapshot of the owner user’s permissions at the time of the request.
+        # The snapshot of the owner’s permissions is updated automatically on every call.
+        # If you don’t specify +role_descriptors+ in the request, a call to this API might still change the API key’s access scope.
+        # This change can occur if the owner user’s permissions have changed since the API key was created or last modified.
+        # To update another user’s API key, use the +run_as+ feature to submit a request on behalf of another user.
+        # IMPORTANT: It’s not possible to use an API key as the authentication credential for this API.
+        # To update an API key, the owner user’s credentials are required.
+        #
+        # @option arguments [String] :id The ID of the API key to update. (*Required*)
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body request body
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-api-key.html
+        #
+        def update_api_key(arguments = {})
+          raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          _id = arguments.delete(:id)
+
+          method = ElasticsearchServerless::API::HTTP_PUT
+          path   = "_security/api_key/#{Utils.listify(_id)}"
+          params = {}
+
+          ElasticsearchServerless::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch-serverless/api/synonyms/put_synonym.rb

@@ -22,7 +22,7 @@ module ElasticsearchServerless
   module API
     module Synonyms
       module Actions
-        # Creates or updates a synonyms set
+        # Creates or updates a synonym set.
         #
         # @option arguments [String] :id The id of the synonyms set to be created or updated (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers

data/lib/elasticsearch-serverless/api/tasks/get.rb

@@ -0,0 +1,57 @@
+# 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.
+#
+# Auto generated from commit f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch-specification
+#
+module ElasticsearchServerless
+  module API
+    module Tasks
+      module Actions
+        # Returns information about a task.
+        # 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] :task_id ID of the task. (*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 [Boolean] :wait_for_completion If +true+, the request blocks until the task has completed.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html
+        #
+        def get(arguments = {})
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          _task_id = arguments.delete(:task_id)
+
+          method = ElasticsearchServerless::API::HTTP_GET
+          path   = "_tasks/#{Utils.listify(_task_id)}"
+          params = Utils.process_params(arguments)
+
+          ElasticsearchServerless::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch-serverless/api/transform/delete_transform.rb

@@ -22,7 +22,7 @@ module ElasticsearchServerless
   module API
     module Transform
       module Actions
-        # Deletes an existing transform.
+        # Deletes a transform.
         #
         # @option arguments [String] :transform_id Identifier for the transform. (*Required*)
         # @option arguments [Boolean] :force If this value is false, the transform must be stopped before it can be deleted. If true, the transform is deleted regardless of its current state.

data/lib/elasticsearch-serverless/api/transform/preview_transform.rb

@@ -24,6 +24,10 @@ module ElasticsearchServerless
       module Actions
         # Previews a transform.
         #
+        # 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 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

data/lib/elasticsearch-serverless/api/transform/put_transform.rb

@@ -22,7 +22,27 @@ module ElasticsearchServerless
   module API
     module Transform
       module Actions
-        # Instantiates 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 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.

data/lib/elasticsearch-serverless/api/transform/reset_transform.rb

@@ -22,7 +22,9 @@ module ElasticsearchServerless
   module API
     module Transform
       module Actions
-        # Resets an existing transform.
+        # Resets 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 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.

data/lib/elasticsearch-serverless/api/transform/schedule_now_transform.rb

@@ -24,6 +24,11 @@ module ElasticsearchServerless
       module Actions
         # Schedules now a transform.
         #
+        # If you _schedule_now a transform, it will process the new data instantly,
+        # without waiting for the configured frequency interval. After _schedule_now API is called,
+        # the transform will be processed again at now + frequency unless _schedule_now API
+        # is called again in the meantime.
+        #
         # @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

data/lib/elasticsearch-serverless/api/transform/start_transform.rb

@@ -22,7 +22,22 @@ module ElasticsearchServerless
   module API
     module Transform
       module Actions
-        # Starts one or more transforms.
+        # Starts 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 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.

data/lib/elasticsearch-serverless/api/transform/update_transform.rb

@@ -24,6 +24,12 @@ module ElasticsearchServerless
       module Actions
         # 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 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.

data/lib/elasticsearch-serverless/api/update_by_query.rb

@@ -21,8 +21,8 @@
 module ElasticsearchServerless
   module API
     module Actions
-      # Performs an update on every document in the index without changing the source,
-      # for example to pick up a mapping change.
+      # Updates documents that match the specified query.
+      # If no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes.
       #
       # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (+*+). To search all data streams or indices, omit this parameter or use +*+ or +_all+. (*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. This behavior applies even if the request targets other open indices. For example, a request targeting +foo*,bar*+ returns an error if an index starts with +foo+ but no index starts with +bar+. Server default: true.

data/lib/elasticsearch-serverless/api.rb

@@ -19,7 +19,7 @@ require 'elasticsearch-serverless/api/response'
 require 'elasticsearch-serverless/api/utils'
 
 # Require everything in /api
-Dir["#{File.dirname(__FILE__)}/api/**/*.rb"].each { |f| require f}
+Dir["#{File.dirname(__FILE__)}/api/**/*.rb"].each { |f| require f }
 
 module ElasticsearchServerless
   module API
@@ -61,13 +61,15 @@ module ElasticsearchServerless
       :cluster,
       :enrich,
       :eql,
+      :esql,
       :graph,
       :indices,
+      :inference,
       :ingest,
       :license,
       :logstash,
       :machine_learning,
-      :query_ruleset,
+      :query_rules,
       :search_application,
       :security,
       :sql,
@@ -81,7 +83,7 @@ module ElasticsearchServerless
       module_name = if UPPERCASE_APIS.include?(name)
                       name.upcase
                     else
-                      name.split("_").map(&:capitalize).join
+                      name.split('_').map(&:capitalize).join
                     end
       class_name = "#{module_name}Client"
 
@@ -94,6 +96,6 @@ module ElasticsearchServerless
       end
     end
     # TODO: If there are more aliases, make this dynamic and add them to constant
-    alias :ml :machine_learning
+    alias ml machine_learning
   end
 end

data/lib/elasticsearch-serverless/version.rb

@@ -16,7 +16,7 @@
 # under the License.
 
 module ElasticsearchServerless
-  API_VERSION = '2023-10-31'
-  CLIENT_VERSION = '0.1.0'
-  VERSION = "#{CLIENT_VERSION}.#{API_VERSION.split('-').join}.pre".freeze
+  API_VERSION = '2023-10-31'.freeze
+  CLIENT_VERSION = '0.2.0'.freeze
+  VERSION = CLIENT_VERSION
 end

data/lib/elasticsearch-serverless.rb

@@ -23,16 +23,24 @@ module ElasticsearchServerless
   class Client
     include ElasticsearchServerless::API
 
-    VALID_PARAMETERS = [:adapter, :log, :logger, :serializer_class, :trace, :tracer, :headers]
+    VALID_PARAMETERS = [:adapter, :log, :logger, :serializer_class, :trace, :tracer, :headers,
+                        :request_timeout, :retry_on_status, :retry_on_failure, :delay_on_retry]
 
     # Initializes an Elasticsearch Serverless Client
     #
-    # @param :api_key [String] Base64 String, format used to authenticate with Elasticsearch
-    # @param :url [String] Elasticsearch endpoint
-    # @param :arguments [Hash] Other optional arguments.
+    # @param [String] api_key Base64 String, format used to authenticate with Elasticsearch
+    # @param [String] url Elasticsearch endpoint
+    # @param [Hash] arguments Other optional arguments.
     # @option arguments [Symbol] :adapter A specific adapter for Faraday (e.g. `:patron`)
     # @option arguments [Boolean] :log Use the default logger (disabled by default)
     # @option arguments [Object] :logger An instance of a Logger-compatible object
+    # @option arguments [Integer] :request_timeout The request timeout to be passed to transport in
+    #                                              options in seconds
+    # @option arguments [Boolean,Number] :retry_on_failure Retry X times when request fails before raising and
+    #                                                      exception (false by default)
+    # @option arguments Array<Number> :retry_on_status Retry when specific status codes are returned
+    # @option arguments [Number] :delay_on_retry Delay in milliseconds between each retry (0 by default)
+    # @option arguments [Boolean] :trace Use the default tracer (disabled by default)
     # @option arguments [Boolean] :trace Use the default tracer (disabled by default)
     # @option arguments [Object] :tracer An instance of a Logger-compatible object
     # @option arguments [Constant] :serializer_class A specific serializer class to use, will be initialized by
@@ -53,7 +61,7 @@ module ElasticsearchServerless
             'Authorization' => "ApiKey #{api_key}",
             'Elastic-Api-Version' => ElasticsearchServerless::API_VERSION,
             user_agent: user_agent
-          },
+          }
         },
         compression: true
       }