elasticsearch-serverless 0.1.0.20231031.pre → 0.3.0

data/lib/elasticsearch-serverless/api/{query_ruleset/delete.rb → query_rules/delete_ruleset.rb}

@@ -20,20 +20,24 @@
 #
 module ElasticsearchServerless
   module API
-    module QueryRuleset
+    module QueryRules
       module Actions
         # Deletes 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 delete (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-query-ruleset.html
         #
-        def delete(arguments = {})
+        def delete_ruleset(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || "query_rules.delete_ruleset" }
+
+          defined_params = [:ruleset_id].inject({}) do |set_variables, variable|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+            set_variables
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
           raise ArgumentError, "Required argument 'ruleset_id' missing" unless arguments[:ruleset_id]
 
           arguments = arguments.clone
@@ -48,7 +52,7 @@ module ElasticsearchServerless
           params = {}
 
           ElasticsearchServerless::API::Response.new(
-            perform_request(method, path, params, body, headers)
+            perform_request(method, path, params, body, headers, request_opts)
           )
         end
       end

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

@@ -0,0 +1,65 @@
+# 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
+        # Returns the details about a query rule within a query ruleset
+        #
+        # @option arguments [String] :ruleset_id The unique identifier of the query ruleset containing the rule to retrieve (*Required*)
+        # @option arguments [String] :rule_id The unique identifier of the query rule within the specified ruleset to retrieve (*Required*)
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/get-query-rule.html
+        #
+        def get_rule(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || "query_rules.get_rule" }
+
+          defined_params = [:ruleset_id, :rule_id].inject({}) do |set_variables, variable|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+            set_variables
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          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 = nil
+
+          _ruleset_id = arguments.delete(:ruleset_id)
+
+          _rule_id = arguments.delete(:rule_id)
+
+          method = ElasticsearchServerless::API::HTTP_GET
+          path   = "_query_rules/#{Utils.listify(_ruleset_id)}/_rule/#{Utils.listify(_rule_id)}"
+          params = {}
+
+          ElasticsearchServerless::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch-serverless/api/{query_ruleset/get.rb → query_rules/get_ruleset.rb}

@@ -20,20 +20,24 @@
 #
 module ElasticsearchServerless
   module API
-    module QueryRuleset
+    module QueryRules
       module Actions
-        # Returns the details about 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.
+        # Returns the details about a query ruleset
         #
         # @option arguments [String] :ruleset_id The unique identifier of the query ruleset (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/get-query-ruleset.html
         #
-        def get(arguments = {})
+        def get_ruleset(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || "query_rules.get_ruleset" }
+
+          defined_params = [:ruleset_id].inject({}) do |set_variables, variable|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+            set_variables
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
           raise ArgumentError, "Required argument 'ruleset_id' missing" unless arguments[:ruleset_id]
 
           arguments = arguments.clone
@@ -48,7 +52,7 @@ module ElasticsearchServerless
           params = {}
 
           ElasticsearchServerless::API::Response.new(
-            perform_request(method, path, params, body, headers)
+            perform_request(method, path, params, body, headers, request_opts)
           )
         end
       end

data/lib/elasticsearch-serverless/api/{query_ruleset/list.rb → query_rules/list_rulesets.rb}

@@ -20,13 +20,9 @@
 #
 module ElasticsearchServerless
   module API
-    module QueryRuleset
+    module QueryRules
       module Actions
-        # Lists query rulesets.
-        # 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.
+        # Returns summarized information about existing query rulesets.
         #
         # @option arguments [Integer] :from Starting offset (default: 0)
         # @option arguments [Integer] :size specifies a max number of results to get
@@ -34,7 +30,9 @@ module ElasticsearchServerless
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/list-query-rulesets.html
         #
-        def list(arguments = {})
+        def list_rulesets(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || "query_rules.list_rulesets" }
+
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
@@ -45,7 +43,7 @@ module ElasticsearchServerless
           params = Utils.process_params(arguments)
 
           ElasticsearchServerless::API::Response.new(
-            perform_request(method, path, params, body, headers)
+            perform_request(method, path, params, body, headers, request_opts)
           )
         end
       end

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

@@ -0,0 +1,67 @@
+# 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 = {})
+          request_opts = { endpoint: arguments[:endpoint] || "query_rules.put_rule" }
+
+          defined_params = [:ruleset_id, :rule_id].inject({}) do |set_variables, variable|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+            set_variables
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          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, request_opts)
+          )
+        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,15 @@ module ElasticsearchServerless
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/put-query-ruleset.html
         #
-        def put(arguments = {})
+        def put_ruleset(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || "query_rules.put_ruleset" }
+
+          defined_params = [:ruleset_id].inject({}) do |set_variables, variable|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+            set_variables
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
           raise ArgumentError, "Required argument 'ruleset_id' missing" unless arguments[:ruleset_id]
 
@@ -50,7 +54,7 @@ module ElasticsearchServerless
           params = {}
 
           ElasticsearchServerless::API::Response.new(
-            perform_request(method, path, params, body, headers)
+            perform_request(method, path, params, body, headers, request_opts)
           )
         end
       end

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

@@ -21,9 +21,10 @@
 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 [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.
       # @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
       # @option arguments [Boolean] :ignore_unavailable If +true+, missing or closed indices are not included in the response.
@@ -34,6 +35,14 @@ module ElasticsearchServerless
       # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/search-rank-eval.html
       #
       def rank_eval(arguments = {})
+        request_opts = { endpoint: arguments[:endpoint] || "rank_eval" }
+
+        defined_params = [:index].inject({}) do |set_variables, variable|
+          set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          set_variables
+        end
+        request_opts[:defined_params] = defined_params unless defined_params.empty?
+
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
 
         arguments = arguments.clone
@@ -52,7 +61,7 @@ module ElasticsearchServerless
         params = Utils.process_params(arguments)
 
         ElasticsearchServerless::API::Response.new(
-          perform_request(method, path, params, body, headers)
+          perform_request(method, path, params, body, headers, request_opts)
         )
       end
     end

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

@@ -21,16 +21,18 @@
 module ElasticsearchServerless
   module API
     module Actions
-      # Allows to copy documents from one index to another, optionally filtering the source
-      # documents by a query, changing the destination index settings, or fetching the
-      # documents from a remote cluster.
+      # Reindex documents.
+      # Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself.
       #
       # @option arguments [Boolean] :refresh If +true+, the request refreshes affected shards to make this operation visible to search.
-      # @option arguments [Float] :requests_per_second The throttle for this request in sub-requests per second. Defaults to no throttle. Server default: -1.
+      # @option arguments [Float] :requests_per_second The throttle for this request in sub-requests per second.
+      #  Defaults to no throttle. Server default: -1.
       # @option arguments [Time] :scroll Specifies how long a consistent view of the index should be maintained for scrolled search.
-      # @option arguments [Integer, String] :slices The number of slices this task should be divided into. Defaults to 1 slice, meaning the task isn’t sliced into subtasks. Server default: 1.
+      # @option arguments [Integer, String] :slices The number of slices this task should be divided into.
+      #  Defaults to 1 slice, meaning the task isn’t sliced into subtasks. Server default: 1.
       # @option arguments [Time] :timeout Period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards. Server default: 1m.
-      # @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 [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.
       # @option arguments [Boolean] :require_alias If +true+, the destination must be an index alias.
       # @option arguments [Hash] :headers Custom HTTP headers
@@ -39,6 +41,8 @@ module ElasticsearchServerless
       # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html
       #
       def reindex(arguments = {})
+        request_opts = { endpoint: arguments[:endpoint] || "reindex" }
+
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
 
         arguments = arguments.clone
@@ -51,7 +55,7 @@ module ElasticsearchServerless
         params = Utils.process_params(arguments)
 
         ElasticsearchServerless::API::Response.new(
-          perform_request(method, path, params, body, headers)
+          perform_request(method, path, params, body, headers, request_opts)
         )
       end
     end

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

@@ -21,15 +21,24 @@
 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 [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
       # @option arguments [Hash] :body request body
       #
       # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/render-search-template-api.html
       #
       def render_search_template(arguments = {})
+        request_opts = { endpoint: arguments[:endpoint] || "render_search_template" }
+
+        defined_params = [:id].inject({}) do |set_variables, variable|
+          set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          set_variables
+        end
+        request_opts[:defined_params] = defined_params unless defined_params.empty?
+
         arguments = arguments.clone
         headers = arguments.delete(:headers) || {}
 
@@ -51,7 +60,7 @@ module ElasticsearchServerless
         params = {}
 
         ElasticsearchServerless::API::Response.new(
-          perform_request(method, path, params, body, headers)
+          perform_request(method, path, params, body, headers, request_opts)
         )
       end
     end

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

@@ -21,7 +21,8 @@
 module ElasticsearchServerless
   module API
     module Actions
-      # Allows an arbitrary script to be executed and a result to be returned
+      # Run a script.
+      # 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
@@ -33,6 +34,8 @@ module ElasticsearchServerless
       # @see https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-api.html
       #
       def scripts_painless_execute(arguments = {})
+        request_opts = { endpoint: arguments[:endpoint] || "scripts_painless_execute" }
+
         arguments = arguments.clone
         headers = arguments.delete(:headers) || {}
 
@@ -48,7 +51,7 @@ module ElasticsearchServerless
         params = {}
 
         ElasticsearchServerless::API::Response.new(
-          perform_request(method, path, params, body, headers)
+          perform_request(method, path, params, body, headers, request_opts)
         )
       end
     end

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

@@ -37,6 +37,14 @@ module ElasticsearchServerless
       # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-body.html#request-body-search-scroll
       #
       def scroll(arguments = {})
+        request_opts = { endpoint: arguments[:endpoint] || "scroll" }
+
+        defined_params = [:scroll_id].inject({}) do |set_variables, variable|
+          set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          set_variables
+        end
+        request_opts[:defined_params] = defined_params unless defined_params.empty?
+
         arguments = arguments.clone
         headers = arguments.delete(:headers) || {}
 
@@ -58,7 +66,7 @@ module ElasticsearchServerless
         params = Utils.process_params(arguments)
 
         ElasticsearchServerless::API::Response.new(
-          perform_request(method, path, params, body, headers)
+          perform_request(method, path, params, body, headers, request_opts)
         )
       end
     end