elasticsearch-serverless 0.1.0.20231031.pre → 0.3.0

data/lib/elasticsearch-serverless/api/indices/put_settings.rb

@@ -22,22 +22,44 @@ module ElasticsearchServerless
   module API
     module Indices
       module Actions
-        # Updates the index settings.
+        # Update index settings.
+        # Changes dynamic index settings in real time. For data streams, index setting
+        # changes are applied to all backing indices by default.
         #
-        # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (+*+). To target 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+.
-        # @option arguments [String, Array<String>] :expand_wildcards 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+. Server default: open.
+        # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases used to limit
+        #  the request. Supports wildcards (+*+). To target 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+.
+        # @option arguments [String, Array<String>] :expand_wildcards 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+. Server default: open.
         # @option arguments [Boolean] :flat_settings If +true+, returns settings in flat format.
         # @option arguments [Boolean] :ignore_unavailable If +true+, returns settings in flat format.
-        # @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] :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 [Boolean] :preserve_existing If +true+, existing index settings remain unchanged.
-        # @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 [Time] :timeout Period to wait for a response. If no response is received before the
+        #   timeout expires, the request fails and returns an error. Server default: 30s.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body settings
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html
         #
         def put_settings(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || "indices.put_settings" }
+
+          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
@@ -56,7 +78,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/indices/put_template.rb

@@ -0,0 +1,71 @@
+# 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 Indices
+      module Actions
+        # Create or update an index template.
+        # Index templates define settings, mappings, and aliases that can be applied automatically to new indices.
+        #
+        # @option arguments [String] :name The name of the template (*Required*)
+        # @option arguments [Boolean] :create If true, this request cannot replace or update existing index templates.
+        # @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 [Integer] :order Order in which Elasticsearch applies this template if index
+        #  matches multiple templates.Templates with lower 'order' values are merged first. Templates with higher
+        #  'order' values are merged later, overriding templates with lower values.
+        # @option arguments [String] :cause [TODO]
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body request body
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates-v1.html
+        #
+        def put_template(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || "indices.put_template" }
+
+          defined_params = [:name].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 'name' missing" unless arguments[:name]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          _name = arguments.delete(:name)
+
+          method = ElasticsearchServerless::API::HTTP_PUT
+          path   = "_template/#{Utils.listify(_name)}"
+          params = Utils.process_params(arguments)
+
+          ElasticsearchServerless::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch-serverless/api/indices/refresh.rb

@@ -22,17 +22,33 @@ module ElasticsearchServerless
   module API
     module Indices
       module Actions
-        # Performs the refresh operation in one or more indices.
+        # Refresh an index.
+        # A refresh makes recent operations performed on one or more indices available for search.
+        # For data streams, the API runs the refresh operation on the stream’s backing indices.
         #
-        # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (+*+). To target 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. Server default: true.
-        # @option arguments [String, Array<String>] :expand_wildcards 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.
+        # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases used to limit the request.
+        #  Supports wildcards (+*+).
+        #  To target 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. Server default: true.
+        # @option arguments [String, Array<String>] :expand_wildcards 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.
         # @option arguments [Boolean] :ignore_unavailable If +false+, the request returns an error if it targets a missing or closed index.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html
         #
         def refresh(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || "indices.refresh" }
+
+          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?
+
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
@@ -49,7 +65,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/indices/resolve_index.rb

@@ -22,15 +22,28 @@ module ElasticsearchServerless
   module API
     module Indices
       module Actions
-        # Returns information about any matching indices, aliases, and data streams
+        # Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams.
+        # Multiple patterns and remote clusters are supported.
         #
-        # @option arguments [String, Array<String>] :name Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve. Resources on remote clusters can be specified using the +<cluster>+:+<name>+ syntax. (*Required*)
-        # @option arguments [String, Array<String>] :expand_wildcards 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.
+        # @option arguments [String, Array<String>] :name Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve.
+        #  Resources on remote clusters can be specified using the +<cluster>+:+<name>+ syntax. (*Required*)
+        # @option arguments [String, Array<String>] :expand_wildcards 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.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-resolve-index-api.html
         #
         def resolve_index(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || "indices.resolve_index" }
+
+          defined_params = [:name].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 'name' missing" unless arguments[:name]
 
           arguments = arguments.clone
@@ -45,7 +58,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/indices/rollover.rb

@@ -22,21 +22,34 @@ module ElasticsearchServerless
   module API
     module Indices
       module Actions
-        # Updates an alias to point to a new index when the existing index
-        # is considered to be too large or too old.
+        # Roll over to a new index.
+        # Creates a new index for a data stream or index alias.
         #
         # @option arguments [String] :alias Name of the data stream or index alias to roll over. (*Required*)
-        # @option arguments [String] :new_index Name of the index to create. Supports date math. Data streams do not support this parameter.
+        # @option arguments [String] :new_index Name of the index to create.
+        #  Supports date math.
+        #  Data streams do not support this parameter.
         # @option arguments [Boolean] :dry_run If +true+, checks whether the current index satisfies the specified conditions but does not perform a rollover.
-        # @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 [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 [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 [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 [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-rollover-index.html
         #
         def rollover(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || "indices.rollover" }
+
+          defined_params = [:alias, :new_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 'alias' missing" unless arguments[:alias]
 
           arguments = arguments.clone
@@ -57,7 +70,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/indices/simulate_index_template.rb

@@ -22,24 +22,31 @@ module ElasticsearchServerless
   module API
     module Indices
       module Actions
-        # Simulate matching the given index name against the index templates in the system
+        # Simulate an index.
+        # Returns the index configuration that would be applied to the specified index from an existing index template.
         #
-        # @option arguments [String] :name Index or template name to simulate (*Required*)
-        # @option arguments [Boolean] :create If +true+, the template passed in the body is only used if no existing templates match the same index patterns. If +false+, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation.
+        # @option arguments [String] :name Name of the index to simulate (*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 [Boolean] :include_defaults If true, returns all relevant default configurations for the index template.
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body request body
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-index.html
         #
         def simulate_index_template(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || "indices.simulate_index_template" }
+
+          defined_params = [:name].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 'name' missing" unless arguments[:name]
 
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body = arguments.delete(:body)
+          body = nil
 
           _name = arguments.delete(:name)
 
@@ -48,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/indices/simulate_template.rb

@@ -22,18 +22,28 @@ module ElasticsearchServerless
   module API
     module Indices
       module Actions
-        # Simulate resolving the given template name or body
+        # Simulate an index template.
+        # Returns the index configuration that would be applied by a particular index template.
         #
-        # @option arguments [String] :name Name of the index template to simulate. To test a template configuration before you add it to the cluster, omit this parameter and specify the template configuration in the request body.
+        # @option arguments [String] :name Name of the index template to simulate. To test a template configuration before you add it to the cluster, omit
+        #  this parameter and specify the template configuration in the request body.
         # @option arguments [Boolean] :create If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation.
         # @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 [Boolean] :include_defaults If true, returns all relevant default configurations for the index template.
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body template
+        # @option arguments [Hash] :body request body
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-template.html
         #
         def simulate_template(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || "indices.simulate_template" }
+
+          defined_params = [:name].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) || {}
 
@@ -50,7 +60,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/indices/update_aliases.rb

@@ -22,16 +22,21 @@ module ElasticsearchServerless
   module API
     module Indices
       module Actions
-        # Updates index aliases.
+        # Create or update an alias.
+        # Adds a data stream or index to an alias.
         #
-        # @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 [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 [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html
         #
         def update_aliases(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || "indices.update_aliases" }
+
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
 
           arguments = arguments.clone
@@ -44,7 +49,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/indices/validate_query.rb

@@ -22,16 +22,25 @@ module ElasticsearchServerless
   module API
     module Indices
       module Actions
-        # Allows a user to validate a potentially expensive query without executing it.
+        # Validate a query.
+        # Validates a query without running it.
         #
-        # @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+.
-        # @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. Server default: true.
+        # @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+.
+        # @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. Server default: true.
         # @option arguments [Boolean] :all_shards If +true+, the validation is executed on all shards instead of one random shard per index.
-        # @option arguments [String] :analyzer Analyzer to use for the query string. This parameter can only be used when the +q+ query string parameter is specified.
+        # @option arguments [String] :analyzer Analyzer to use for the query string.
+        #  This parameter can only be used when the +q+ query string parameter is specified.
         # @option arguments [Boolean] :analyze_wildcard If +true+, wildcard and prefix queries are analyzed.
         # @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. This parameter can only be used when the +q+ query string parameter is specified.
-        # @option arguments [String, Array<String>] :expand_wildcards 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.
+        # @option arguments [String] :df Field to use as default where no field prefix is given in the query string.
+        #  This parameter can only be used when the +q+ query string parameter is specified.
+        # @option arguments [String, Array<String>] :expand_wildcards 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.
         # @option arguments [Boolean] :explain If +true+, the response returns detailed information if an error has occurred.
         # @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.
@@ -43,6 +52,14 @@ module ElasticsearchServerless
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html
         #
         def validate_query(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || "indices.validate_query" }
+
+          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?
+
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
@@ -64,7 +81,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/inference/delete.rb

@@ -0,0 +1,74 @@
+# 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 Inference
+      module Actions
+        # Delete an inference endpoint
+        # 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_type The task type
+        # @option arguments [String] :inference_id The inference Id (*Required*)
+        # @option arguments [Boolean] :dry_run When true, the endpoint is not deleted, and a list of ingest processors which reference this endpoint is returned
+        # @option arguments [Boolean] :force When true, the inference endpoint is forcefully deleted even if it is still being used by ingest processors or semantic text fields
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-inference-api.html
+        #
+        def delete(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || "inference.delete" }
+
+          defined_params = [:inference_id, :task_type].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 'inference_id' missing" unless arguments[:inference_id]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          _task_type = arguments.delete(:task_type)
+
+          _inference_id = arguments.delete(:inference_id)
+
+          method = ElasticsearchServerless::API::HTTP_DELETE
+          path   = if _task_type && _inference_id
+                     "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_inference_id)}"
+                   else
+                     "_inference/#{Utils.listify(_inference_id)}"
+                   end
+          params = Utils.process_params(arguments)
+
+          ElasticsearchServerless::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+# 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 Inference
+      module Actions
+        # Get an inference endpoint
+        # 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_type The task type
+        # @option arguments [String] :inference_id The inference Id
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/get-inference-api.html
+        #
+        def get(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || "inference.get" }
+
+          defined_params = [:inference_id, :task_type].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) || {}
+
+          body = nil
+
+          _task_type = arguments.delete(:task_type)
+
+          _inference_id = arguments.delete(:inference_id)
+
+          method = ElasticsearchServerless::API::HTTP_GET
+          path   = if _task_type && _inference_id
+                     "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_inference_id)}"
+                   elsif _inference_id
+                     "_inference/#{Utils.listify(_inference_id)}"
+                   else
+                     "_inference"
+                   end
+          params = {}
+
+          ElasticsearchServerless::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end