elasticsearch-serverless 0.6.0 → 0.7.0

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

@@ -22,31 +22,57 @@ module ElasticsearchServerless
   module API
     module Actions
       # Delete a document.
-      # Removes a JSON document from the specified index.
+      # Remove a JSON document from the specified index.
+      # NOTE: You cannot send deletion requests directly to a data stream.
+      # To delete a document in a data stream, you must target the backing index containing the document.
+      # **Optimistic concurrency control**
+      # Delete operations can be made conditional and only be performed if the last modification to the document was assigned the sequence number and primary term specified by the +if_seq_no+ and +if_primary_term+ parameters.
+      # If a mismatch is detected, the operation will result in a +VersionConflictException+ and a status code of +409+.
+      # **Versioning**
+      # Each document indexed is versioned.
+      # When deleting a document, the version can be specified to make sure the relevant document you are trying to delete is actually being deleted and it has not changed in the meantime.
+      # Every write operation run on a document, deletes included, causes its version to be incremented.
+      # The version number of a deleted document remains available for a short time after deletion to allow for control of concurrent operations.
+      # The length of time for which a deleted document's version remains available is determined by the +index.gc_deletes+ index setting.
+      # **Routing**
+      # If routing is used during indexing, the routing value also needs to be specified to delete a document.
+      # If the +_routing+ mapping is set to +required+ and no routing value is specified, the delete API throws a +RoutingMissingException+ and rejects the request.
+      # For example:
+      # +
+      # DELETE /my-index-000001/_doc/1?routing=shard-1
+      # +
+      # This request deletes the document with ID 1, but it is routed based on the user.
+      # The document is not deleted if the correct routing is not specified.
+      # **Distributed**
+      # The delete operation gets hashed into a specific shard ID.
+      # It then gets redirected into the primary shard within that ID group and replicated (if needed) to shard replicas within that ID group.
       #
-      # @option arguments [String] :id Unique identifier for the document. (*Required*)
-      # @option arguments [String] :index Name of the target index. (*Required*)
+      # @option arguments [String] :id A unique identifier for the document. (*Required*)
+      # @option arguments [String] :index The name of the target index. (*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 [String] :refresh If +true+, Elasticsearch refreshes 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+ do nothing with refreshes.
-      #  Valid values: +true+, +false+, +wait_for+. Server default: false.
-      # @option arguments [String] :routing Custom value used to route operations to a specific shard.
-      # @option arguments [Time] :timeout Period to wait for active shards. Server default: 1m.
-      # @option arguments [Integer] :version Explicit version number for concurrency control.
-      #  The specified version must match the current version of the document for the request to succeed.
-      # @option arguments [String] :version_type Specific version type: +external+, +external_gte+.
-      # @option arguments [Integer, String] :wait_for_active_shards The number of shard copies 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+). Server default: 1.
+      # @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 [String] :routing A custom value used to route operations to a specific shard.
+      # @option arguments [Time] :timeout The period to wait for active shards.This parameter is useful for situations where the primary shard assigned to perform the delete operation might not be available when the delete operation runs.
+      #  Some reasons for this might be that the primary shard is currently recovering from a store or undergoing relocation.
+      #  By default, the delete operation will wait on the primary shard to become available for up to 1 minute before failing and responding with an error. Server default: 1m.
+      # @option arguments [Integer] :version An explicit version number for concurrency control.
+      #  It must match the current version of the document for the request to succeed.
+      # @option arguments [String] :version_type The version type.
+      # @option arguments [Integer, String] :wait_for_active_shards The minimum number of shard copies that must be active before proceeding with the operation.
+      #  You can set it 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 [Hash] :headers Custom HTTP headers
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete
       #
       def delete(arguments = {})
-        request_opts = { endpoint: arguments[:endpoint] || "delete" }
+        request_opts = { endpoint: arguments[:endpoint] || 'delete' }
 
-        defined_params = [:index, :id].inject({}) do |set_variables, variable|
+        defined_params = [:index, :id].each_with_object({}) do |variable, set_variables|
           set_variables[variable] = arguments[variable] if arguments.key?(variable)
-          set_variables
         end
         request_opts[:defined_params] = defined_params unless defined_params.empty?
 
@@ -67,11 +93,11 @@ module ElasticsearchServerless
         params = Utils.process_params(arguments)
 
         if Array(arguments[:ignore]).include?(404)
-          Utils.rescue_from_not_found {
+          Utils.rescue_from_not_found do
             ElasticsearchServerless::API::Response.new(
               perform_request(method, path, params, body, headers, request_opts)
             )
-          }
+          end
         else
           ElasticsearchServerless::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

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

@@ -23,66 +23,128 @@ module ElasticsearchServerless
     module Actions
       # Delete documents.
       # Deletes documents that match the specified query.
+      # If the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or alias:
+      # * +read+
+      # * +delete+ or +write+
+      # You can specify the query criteria in the request URI or the request body using the same syntax as the search API.
+      # When you submit a delete by query request, Elasticsearch gets a snapshot of the data stream or index when it begins processing the request and deletes matching documents using internal versioning.
+      # If a document changes between the time that the snapshot is taken and the delete operation is processed, it results in a version conflict and the delete operation fails.
+      # NOTE: Documents with a version equal to 0 cannot be deleted using delete by query because internal versioning does not support 0 as a valid version number.
+      # While processing a delete by query request, Elasticsearch performs multiple search requests sequentially to find all of the matching documents to delete.
+      # A bulk delete request is performed for each batch of matching documents.
+      # If a search or bulk request is rejected, the requests are retried up to 10 times, with exponential back off.
+      # If the maximum retry limit is reached, processing halts and all failed requests are returned in the response.
+      # Any delete requests that completed successfully still stick, they are not rolled back.
+      # You can opt to count version conflicts instead of halting and returning by setting +conflicts+ to +proceed+.
+      # Note that if you opt to count version conflicts the operation could attempt to delete more documents from the source than +max_docs+ until it has successfully deleted +max_docs documents+, or it has gone through every document in the source query.
+      # **Throttling delete requests**
+      # To control the rate at which delete by query issues batches of delete operations, you can set +requests_per_second+ to any positive decimal number.
+      # This pads each batch with a wait time to throttle the rate.
+      # Set +requests_per_second+ to +-1+ to disable throttling.
+      # Throttling uses a wait time between batches so that the internal scroll requests can be given a timeout that takes the request padding into account.
+      # The padding time is the difference between the batch size divided by the +requests_per_second+ and the time spent writing.
+      # By default the batch size is +1000+, so if +requests_per_second+ is set to +500+:
+      # +
+      # target_time = 1000 / 500 per second = 2 seconds
+      # wait_time = target_time - write_time = 2 seconds - .5 seconds = 1.5 seconds
+      # +
+      # Since the batch is issued as a single +_bulk+ request, large batch sizes cause Elasticsearch to create many requests and wait before starting the next set.
+      # This is "bursty" instead of "smooth".
+      # **Slicing**
+      # Delete by query supports sliced scroll to parallelize the delete process.
+      # This can improve efficiency and provide a convenient way to break the request down into smaller parts.
+      # Setting +slices+ to +auto+ lets Elasticsearch choose the number of slices to use.
+      # This setting will use one slice per shard, up to a certain limit.
+      # If there are multiple source data streams or indices, it will choose the number of slices based on the index or backing index with the smallest number of shards.
+      # Adding slices to the delete by query operation creates sub-requests which means it has some quirks:
+      # * You can see these requests in the tasks APIs. These sub-requests are "child" tasks of the task for the request with slices.
+      # * Fetching the status of the task for the request with slices only contains the status of completed slices.
+      # * These sub-requests are individually addressable for things like cancellation and rethrottling.
+      # * Rethrottling the request with +slices+ will rethrottle the unfinished sub-request proportionally.
+      # * Canceling the request with +slices+ will cancel each sub-request.
+      # * Due to the nature of +slices+ each sub-request won't get a perfectly even portion of the documents. All documents will be addressed, but some slices may be larger than others. Expect larger slices to have a more even distribution.
+      # * Parameters like +requests_per_second+ and +max_docs+ on a request with +slices+ are distributed proportionally to each sub-request. Combine that with the earlier point about distribution being uneven and you should conclude that using +max_docs+ with +slices+ might not result in exactly +max_docs+ documents being deleted.
+      # * Each sub-request gets a slightly different snapshot of the source data stream or index though these are all taken at approximately the same time.
+      # If you're slicing manually or otherwise tuning automatic slicing, keep in mind that:
+      # * Query performance is most efficient when the number of slices is equal to the number of shards in the index or backing index. If that number is large (for example, 500), choose a lower number as too many +slices+ hurts performance. Setting +slices+ higher than the number of shards generally does not improve efficiency and adds overhead.
+      # * Delete performance scales linearly across available resources with the number of slices.
+      # Whether query or delete performance dominates the runtime depends on the documents being reindexed and cluster resources.
+      # **Cancel a delete by query operation**
+      # Any delete by query can be canceled using the task cancel API. For example:
+      # +
+      # POST _tasks/r1A2WoRbTwKZ516z6NEs5A:36619/_cancel
+      # +
+      # The task ID can be found by using the get tasks API.
+      # Cancellation should happen quickly but might take a few seconds.
+      # The get task status API will continue to list the delete by query task until this task checks that it has been cancelled and terminates itself.
       #
-      # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases to search.
-      #  Supports wildcards (+*+).
+      # @option arguments [String, Array] :index A comma-separated list of data streams, indices, and aliases to search.
+      #  It 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.
       # @option arguments [String] :analyzer Analyzer to use for the query string.
+      #  This parameter can be used only when the +q+ query string parameter is specified.
       # @option arguments [Boolean] :analyze_wildcard If +true+, wildcard and prefix queries are analyzed.
+      #  This parameter can be used only when the +q+ query string parameter is specified.
       # @option arguments [String] :conflicts What to do if delete by query hits version conflicts: +abort+ or +proceed+. Server default: abort.
-      # @option arguments [String] :default_operator The default operator for query string query: +AND+ or +OR+. Server default: OR.
-      # @option arguments [String] :df Field to use as default where no field prefix is given in the query string.
-      # @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match.
+      # @option arguments [String] :default_operator The default operator for query string query: +AND+ or +OR+.
+      #  This parameter can be used only when the +q+ query string parameter is specified. Server default: OR.
+      # @option arguments [String] :df The field to use as default where no field prefix is given in the query string.
+      #  This parameter can be used only when the +q+ query string parameter is specified.
+      # @option arguments [String, Array<String>] :expand_wildcards The type of index that wildcard patterns can match.
       #  If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
-      #  Supports comma-separated values, such as +open,hidden+. Valid values are: +all+, +open+, +closed+, +hidden+, +none+. Server default: open.
+      #  It supports comma-separated values, such as +open,hidden+. Server default: open.
       # @option arguments [Integer] :from Starting offset (default: 0)
       # @option arguments [Boolean] :ignore_unavailable If +false+, the request returns an error if it targets a missing or closed index.
       # @option arguments [Boolean] :lenient If +true+, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.
-      # @option arguments [Integer] :max_docs Maximum number of documents to process.
+      #  This parameter can be used only when the +q+ query string parameter is specified.
+      # @option arguments [Integer] :max_docs The maximum number of documents to process.
       #  Defaults to all documents.
-      # @option arguments [String] :preference Specifies the node or shard the operation should be performed on.
-      #  Random by default.
+      #  When set to a value less then or equal to +scroll_size+, a scroll will not be used to retrieve the results for the operation.
+      # @option arguments [String] :preference The node or shard the operation should be performed on.
+      #  It is random by default.
       # @option arguments [Boolean] :refresh If +true+, Elasticsearch refreshes all shards involved in the delete by query after the request completes.
+      #  This is different than the delete API's +refresh+ parameter, which causes just the shard that received the delete request to be refreshed.
+      #  Unlike the delete API, it does not support +wait_for+.
       # @option arguments [Boolean] :request_cache If +true+, the request cache is used for this request.
       #  Defaults to the index-level setting.
-      # @option arguments [Float] :requests_per_second The throttle for this request in sub-requests per second.
-      # @option arguments [String] :routing Custom value used to route operations to a specific shard.
-      # @option arguments [String] :q Query in the Lucene query string syntax.
-      # @option arguments [Time] :scroll Period to retain the search context for scrolling.
-      # @option arguments [Integer] :scroll_size Size of the scroll request that powers the operation. Server default: 1000.
-      # @option arguments [Time] :search_timeout Explicit timeout for each search request.
-      #  Defaults to no timeout.
+      # @option arguments [Float] :requests_per_second The throttle for this request in sub-requests per second. Server default: -1.
+      # @option arguments [String] :routing A custom value used to route operations to a specific shard.
+      # @option arguments [String] :q A query in the Lucene query string syntax.
+      # @option arguments [Time] :scroll The period to retain the search context for scrolling.
+      # @option arguments [Integer] :scroll_size The size of the scroll request that powers the operation. Server default: 1000.
+      # @option arguments [Time] :search_timeout The explicit timeout for each search request.
+      #  It defaults to no timeout.
       # @option arguments [String] :search_type The type of the search operation.
-      #  Available options: +query_then_fetch+, +dfs_query_then_fetch+.
+      #  Available options include +query_then_fetch+ and +dfs_query_then_fetch+.
       # @option arguments [Integer, String] :slices The number of slices this task should be divided into. Server default: 1.
-      # @option arguments [Array<String>] :sort A comma-separated list of <field>:<direction> pairs.
-      # @option arguments [Array<String>] :stats Specific +tag+ of the request for logging and statistical purposes.
-      # @option arguments [Integer] :terminate_after Maximum number of documents to collect for each shard.
+      # @option arguments [Array<String>] :sort A comma-separated list of +<field>:<direction>+ pairs.
+      # @option arguments [Array<String>] :stats The specific +tag+ of the request for logging and statistical purposes.
+      # @option arguments [Integer] :terminate_after The maximum number of documents to collect for each shard.
       #  If a query reaches this limit, Elasticsearch terminates the query early.
-      #  Elasticsearch collects documents before sorting.
-      #  Use with caution.
+      #  Elasticsearch collects documents before sorting.Use with caution.
       #  Elasticsearch applies this parameter to each shard handling the request.
       #  When possible, let Elasticsearch perform early termination automatically.
       #  Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.
-      # @option arguments [Time] :timeout Period each deletion request waits for active shards. Server default: 1m.
+      # @option arguments [Time] :timeout The period each deletion request waits for active shards. Server default: 1m.
       # @option arguments [Boolean] :version If +true+, returns the document version as part of a hit.
       # @option arguments [Integer, String] :wait_for_active_shards The number of shard copies 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+). Server default: 1.
-      # @option arguments [Boolean] :wait_for_completion If +true+, the request blocks until the operation is complete. Server default: true.
+      #  Set to +all+ or any positive integer up to the total number of shards in the index (+number_of_replicas+1+).
+      #  The +timeout+ value controls how long each write request waits for unavailable shards to become available. Server default: 1.
+      # @option arguments [Boolean] :wait_for_completion If +true+, the request blocks until the operation is complete.
+      #  If +false+, Elasticsearch performs some preflight checks, launches the request, and returns a task you can use to cancel or get the status of the task. Elasticsearch creates a record of this task as a document at +.tasks/task/${taskId}+. When you are done with a task, you should delete the task document so Elasticsearch can reclaim the space. Server default: true.
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body request body
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete-by-query
       #
       def delete_by_query(arguments = {})
-        request_opts = { endpoint: arguments[:endpoint] || "delete_by_query" }
+        request_opts = { endpoint: arguments[:endpoint] || 'delete_by_query' }
 
-        defined_params = [:index].inject({}) do |set_variables, variable|
+        defined_params = [:index].each_with_object({}) do |variable, set_variables|
           set_variables[variable] = arguments[variable] if arguments.key?(variable)
-          set_variables
         end
         request_opts[:defined_params] = defined_params unless defined_params.empty?
 

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

@@ -24,21 +24,22 @@ module ElasticsearchServerless
       # Delete a script or search template.
       # Deletes a stored script or search template.
       #
-      # @option arguments [String] :id Identifier for the stored script or search template. (*Required*)
-      # @option arguments [Time] :master_timeout Period to wait for a connection to the master node.
-      #  If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
-      # @option arguments [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] :id The identifier for the stored script or search template. (*Required*)
+      # @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
+      #  If no response is received before the timeout expires, the request fails and returns an error.
+      #  It can also be set to +-1+ to indicate that the request should never timeout. Server default: 30s.
+      # @option arguments [Time] :timeout The period to wait for a response.
+      #  If no response is received before the timeout expires, the request fails and returns an error.
+      #  It can also be set to +-1+ to indicate that the request should never timeout. Server default: 30s.
       # @option arguments [Hash] :headers Custom HTTP headers
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete-script
       #
       def delete_script(arguments = {})
-        request_opts = { endpoint: arguments[:endpoint] || "delete_script" }
+        request_opts = { endpoint: arguments[:endpoint] || 'delete_script' }
 
-        defined_params = [:id].inject({}) do |set_variables, variable|
+        defined_params = [:id].each_with_object({}) do |variable, set_variables|
           set_variables[variable] = arguments[variable] if arguments.key?(variable)
-          set_variables
         end
         request_opts[:defined_params] = defined_params unless defined_params.empty?
 

data/lib/elasticsearch-serverless/api/enrich/delete_policy.rb

@@ -26,16 +26,16 @@ module ElasticsearchServerless
         # Deletes an existing enrich policy and its enrich index.
         #
         # @option arguments [String] :name Enrich policy to delete. (*Required*)
+        # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-enrich-policy-api.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-delete-policy
         #
         def delete_policy(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "enrich.delete_policy" }
+          request_opts = { endpoint: arguments[:endpoint] || 'enrich.delete_policy' }
 
-          defined_params = [:name].inject({}) do |set_variables, variable|
+          defined_params = [:name].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
-            set_variables
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 
@@ -50,7 +50,7 @@ module ElasticsearchServerless
 
           method = ElasticsearchServerless::API::HTTP_DELETE
           path   = "_enrich/policy/#{Utils.listify(_name)}"
-          params = {}
+          params = Utils.process_params(arguments)
 
           ElasticsearchServerless::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch-serverless/api/enrich/execute_policy.rb

@@ -22,20 +22,21 @@ module ElasticsearchServerless
   module API
     module Enrich
       module Actions
-        # Creates the enrich index for an existing enrich policy.
+        # Run an enrich policy.
+        # Create the enrich index for an existing enrich policy.
         #
         # @option arguments [String] :name Enrich policy to execute. (*Required*)
+        # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
         # @option arguments [Boolean] :wait_for_completion If +true+, the request blocks other enrich policy execution requests until complete. Server default: true.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/execute-enrich-policy-api.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-execute-policy
         #
         def execute_policy(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "enrich.execute_policy" }
+          request_opts = { endpoint: arguments[:endpoint] || 'enrich.execute_policy' }
 
-          defined_params = [:name].inject({}) do |set_variables, variable|
+          defined_params = [:name].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
-            set_variables
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 

data/lib/elasticsearch-serverless/api/enrich/get_policy.rb

@@ -27,16 +27,16 @@ module ElasticsearchServerless
         #
         # @option arguments [String, Array<String>] :name Comma-separated list of enrich policy names used to limit the request.
         #  To return information for all enrich policies, omit this parameter.
+        # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-get-policy
         #
         def get_policy(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "enrich.get_policy" }
+          request_opts = { endpoint: arguments[:endpoint] || 'enrich.get_policy' }
 
-          defined_params = [:name].inject({}) do |set_variables, variable|
+          defined_params = [:name].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
-            set_variables
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 
@@ -51,9 +51,9 @@ module ElasticsearchServerless
           path   = if _name
                      "_enrich/policy/#{Utils.listify(_name)}"
                    else
-                     "_enrich/policy"
+                     '_enrich/policy'
                    end
-          params = {}
+          params = Utils.process_params(arguments)
 
           ElasticsearchServerless::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch-serverless/api/enrich/put_policy.rb

@@ -26,17 +26,17 @@ module ElasticsearchServerless
         # Creates an enrich policy.
         #
         # @option arguments [String] :name Name of the enrich policy to create or update. (*Required*)
+        # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/put-enrich-policy-api.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-put-policy
         #
         def put_policy(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "enrich.put_policy" }
+          request_opts = { endpoint: arguments[:endpoint] || 'enrich.put_policy' }
 
-          defined_params = [:name].inject({}) do |set_variables, variable|
+          defined_params = [:name].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
-            set_variables
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 
@@ -52,7 +52,7 @@ module ElasticsearchServerless
 
           method = ElasticsearchServerless::API::HTTP_PUT
           path   = "_enrich/policy/#{Utils.listify(_name)}"
-          params = {}
+          params = Utils.process_params(arguments)
 
           ElasticsearchServerless::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch-serverless/api/eql/delete.rb

@@ -22,7 +22,8 @@ module ElasticsearchServerless
   module API
     module Eql
       module Actions
-        # Deletes an async EQL search or a stored synchronous EQL search.
+        # Delete an async EQL search.
+        # Delete an async EQL search or a stored synchronous EQL search.
         # The API also deletes results for the search.
         #
         # @option arguments [String] :id Identifier for the search to delete.
@@ -30,14 +31,13 @@ module ElasticsearchServerless
         #  A search ID is also provided if the request’s +keep_on_completion+ parameter is +true+. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-delete
         #
         def delete(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "eql.delete" }
+          request_opts = { endpoint: arguments[:endpoint] || 'eql.delete' }
 
-          defined_params = [:id].inject({}) do |set_variables, variable|
+          defined_params = [:id].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
-            set_variables
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 

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

@@ -22,7 +22,8 @@ module ElasticsearchServerless
   module API
     module Eql
       module Actions
-        # Returns the current status and available results for an async EQL search or a stored synchronous EQL search.
+        # Get async EQL search results.
+        # Get the current status and available results for an async EQL search or a stored synchronous EQL search.
         #
         # @option arguments [String] :id Identifier for the search. (*Required*)
         # @option arguments [Time] :keep_alive Period for which the search and its results are stored on the cluster.
@@ -31,14 +32,13 @@ module ElasticsearchServerless
         #  Defaults to no timeout, meaning the request waits for complete search results.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-async-eql-search-api.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-get
         #
         def get(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "eql.get" }
+          request_opts = { endpoint: arguments[:endpoint] || 'eql.get' }
 
-          defined_params = [:id].inject({}) do |set_variables, variable|
+          defined_params = [:id].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
-            set_variables
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 

data/lib/elasticsearch-serverless/api/eql/get_status.rb

@@ -22,19 +22,19 @@ module ElasticsearchServerless
   module API
     module Eql
       module Actions
-        # Returns the current status for an async EQL search or a stored synchronous EQL search without returning results.
+        # Get the async EQL status.
+        # Get the current status for an async EQL search or a stored synchronous EQL search without returning results.
         #
         # @option arguments [String] :id Identifier for the search. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-async-eql-status-api.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-get-status
         #
         def get_status(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "eql.get_status" }
+          request_opts = { endpoint: arguments[:endpoint] || 'eql.get_status' }
 
-          defined_params = [:id].inject({}) do |set_variables, variable|
+          defined_params = [:id].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
-            set_variables
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 

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

@@ -22,10 +22,15 @@ module ElasticsearchServerless
   module API
     module Eql
       module Actions
-        # Returns results matching a query expressed in Event Query Language (EQL)
+        # Get EQL search results.
+        # Returns search results for an Event Query Language (EQL) query.
+        # EQL assumes each document in a data stream or index corresponds to an event.
         #
         # @option arguments [String, Array] :index The name of the index to scope the operation (*Required*)
         # @option arguments [Boolean] :allow_no_indices [TODO] Server default: true.
+        # @option arguments [Boolean] :allow_partial_search_results If true, returns partial results if there are shard failures. If false, returns an error with no partial results. Server default: true.
+        # @option arguments [Boolean] :allow_partial_sequence_results If true, sequence queries will return partial results in case of shard failures. If false, they will return no results at all.
+        #  This flag has effect only if allow_partial_search_results is true.
         # @option arguments [String, Array<String>] :expand_wildcards [TODO] Server default: open.
         # @option arguments [Boolean] :ignore_unavailable If true, missing or closed indices are not included in the response. Server default: true.
         # @option arguments [Time] :keep_alive Period for which the search and its results are stored on the cluster. Server default: 5d.
@@ -34,14 +39,13 @@ module ElasticsearchServerless
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-search
         #
         def search(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "eql.search" }
+          request_opts = { endpoint: arguments[:endpoint] || 'eql.search' }
 
-          defined_params = [:index].inject({}) do |set_variables, variable|
+          defined_params = [:index].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
-            set_variables
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?