elasticsearch-serverless 0.1.0.20231031.pre → 0.3.0

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

@@ -21,23 +21,35 @@
 module ElasticsearchServerless
   module API
     module Actions
-      # Performs an update on every document in the index without changing the source,
-      # for example to pick up a mapping change.
+      # Update documents.
+      # Updates documents that match the specified query.
+      # If no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes.
       #
-      # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (+*+). To search all data streams or indices, omit this parameter or use +*+ or +_all+. (*Required*)
-      # @option arguments [Boolean] :allow_no_indices If +false+, the request returns an error if any wildcard expression, index alias, or +_all+ value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting +foo*,bar*+ returns an error if an index starts with +foo+ but no index starts with +bar+. Server default: true.
+      # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases to search.
+      #  Supports wildcards (+*+).
+      #  To search all data streams or indices, omit this parameter or use +*+ or +_all+. (*Required*)
+      # @option arguments [Boolean] :allow_no_indices If +false+, the request returns an error if any wildcard expression, index alias, or +_all+ value targets only missing or closed indices.
+      #  This behavior applies even if the request targets other open indices.
+      #  For example, a request targeting +foo*,bar*+ returns an error if an index starts with +foo+ but no index starts with +bar+. Server default: true.
       # @option arguments [String] :analyzer Analyzer to use for the query string.
       # @option arguments [Boolean] :analyze_wildcard If +true+, wildcard and prefix queries are analyzed.
       # @option arguments [String] :conflicts What to do if update 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. 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+.
+      # @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+.
       # @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. Defaults to all documents.
-      # @option arguments [String] :pipeline ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, then setting the value to +_none+ disables the default ingest pipeline for this request. If a final pipeline is configured it will always run, regardless of the value of this parameter.
-      # @option arguments [String] :preference Specifies the node or shard the operation should be performed on. Random by default.
+      # @option arguments [Integer] :max_docs Maximum number of documents to process.
+      #  Defaults to all documents.
+      # @option arguments [String] :pipeline ID of the pipeline to use to preprocess incoming documents.
+      #  If the index has a default ingest pipeline specified, then setting the value to +_none+ disables the default ingest pipeline for this request.
+      #  If a final pipeline is configured it will always run, regardless of the value of this parameter.
+      # @option arguments [String] :preference Specifies the node or shard the operation should be performed on.
+      #  Random by default.
       # @option arguments [Boolean] :refresh If +true+, Elasticsearch refreshes affected shards to make the operation visible to search.
       # @option arguments [Boolean] :request_cache If +true+, the request cache is used for this request.
       # @option arguments [Float] :requests_per_second The throttle for this request in sub-requests per second. Server default: -1.
@@ -49,11 +61,18 @@ module ElasticsearchServerless
       # @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. If a query reaches this limit, Elasticsearch terminates the query early. 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 [Integer] :terminate_after 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 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 update request waits for the following operations: dynamic mapping updates, waiting for active shards. Server default: 1m.
       # @option arguments [Boolean] :version If +true+, returns the document version as part of a hit.
       # @option arguments [Boolean] :version_type Should the document increment the version number (internal) on hit or not (reindex)
-      # @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 [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body request body
@@ -61,6 +80,14 @@ module ElasticsearchServerless
       # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html
       #
       def update_by_query(arguments = {})
+        request_opts = { endpoint: arguments[:endpoint] || "update_by_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?
+
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
 
         arguments = arguments.clone
@@ -75,7 +102,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.rb

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

data/lib/elasticsearch-serverless/version.rb

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

data/lib/elasticsearch-serverless.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-serverless
 version: !ruby/object:Gem::Version
-  version: 0.1.0.20231031.pre
+  version: 0.3.0
 platform: ruby
 authors:
 - Fernando Briano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-28 00:00:00.000000000 Z
+date: 2024-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elastic-transport
@@ -16,70 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '8.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8'
-- !ruby/object:Gem::Dependency
-  name: debug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: faraday-net_http_persistent
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '8.3'
 description: 
 email: support@elastic.co
 executables: []
@@ -110,6 +54,30 @@ files:
 - lib/elasticsearch-serverless/api/cluster/get_component_template.rb
 - lib/elasticsearch-serverless/api/cluster/info.rb
 - lib/elasticsearch-serverless/api/cluster/put_component_template.rb
+- lib/elasticsearch-serverless/api/connector/check_in.rb
+- lib/elasticsearch-serverless/api/connector/delete.rb
+- lib/elasticsearch-serverless/api/connector/get.rb
+- lib/elasticsearch-serverless/api/connector/list.rb
+- lib/elasticsearch-serverless/api/connector/post.rb
+- lib/elasticsearch-serverless/api/connector/put.rb
+- lib/elasticsearch-serverless/api/connector/sync_job_cancel.rb
+- lib/elasticsearch-serverless/api/connector/sync_job_delete.rb
+- lib/elasticsearch-serverless/api/connector/sync_job_get.rb
+- lib/elasticsearch-serverless/api/connector/sync_job_list.rb
+- lib/elasticsearch-serverless/api/connector/sync_job_post.rb
+- lib/elasticsearch-serverless/api/connector/update_active_filtering.rb
+- lib/elasticsearch-serverless/api/connector/update_api_key_id.rb
+- lib/elasticsearch-serverless/api/connector/update_configuration.rb
+- lib/elasticsearch-serverless/api/connector/update_error.rb
+- lib/elasticsearch-serverless/api/connector/update_filtering.rb
+- lib/elasticsearch-serverless/api/connector/update_filtering_validation.rb
+- lib/elasticsearch-serverless/api/connector/update_index_name.rb
+- lib/elasticsearch-serverless/api/connector/update_name.rb
+- lib/elasticsearch-serverless/api/connector/update_native.rb
+- lib/elasticsearch-serverless/api/connector/update_pipeline.rb
+- lib/elasticsearch-serverless/api/connector/update_scheduling.rb
+- lib/elasticsearch-serverless/api/connector/update_service_type.rb
+- lib/elasticsearch-serverless/api/connector/update_status.rb
 - lib/elasticsearch-serverless/api/count.rb
 - lib/elasticsearch-serverless/api/create.rb
 - lib/elasticsearch-serverless/api/delete.rb
@@ -124,6 +92,7 @@ files:
 - lib/elasticsearch-serverless/api/eql/get.rb
 - lib/elasticsearch-serverless/api/eql/get_status.rb
 - lib/elasticsearch-serverless/api/eql/search.rb
+- lib/elasticsearch-serverless/api/esql/query.rb
 - lib/elasticsearch-serverless/api/exists.rb
 - lib/elasticsearch-serverless/api/exists_source.rb
 - lib/elasticsearch-serverless/api/explain.rb
@@ -161,6 +130,7 @@ files:
 - lib/elasticsearch-serverless/api/indices/put_index_template.rb
 - lib/elasticsearch-serverless/api/indices/put_mapping.rb
 - lib/elasticsearch-serverless/api/indices/put_settings.rb
+- lib/elasticsearch-serverless/api/indices/put_template.rb
 - lib/elasticsearch-serverless/api/indices/refresh.rb
 - lib/elasticsearch-serverless/api/indices/resolve_index.rb
 - lib/elasticsearch-serverless/api/indices/rollover.rb
@@ -168,6 +138,10 @@ files:
 - lib/elasticsearch-serverless/api/indices/simulate_template.rb
 - lib/elasticsearch-serverless/api/indices/update_aliases.rb
 - lib/elasticsearch-serverless/api/indices/validate_query.rb
+- lib/elasticsearch-serverless/api/inference/delete.rb
+- lib/elasticsearch-serverless/api/inference/get.rb
+- lib/elasticsearch-serverless/api/inference/inference.rb
+- lib/elasticsearch-serverless/api/inference/put.rb
 - lib/elasticsearch-serverless/api/info.rb
 - lib/elasticsearch-serverless/api/ingest/delete_pipeline.rb
 - lib/elasticsearch-serverless/api/ingest/get_pipeline.rb
@@ -203,6 +177,7 @@ files:
 - lib/elasticsearch-serverless/api/machine_learning/get_overall_buckets.rb
 - lib/elasticsearch-serverless/api/machine_learning/get_trained_models.rb
 - lib/elasticsearch-serverless/api/machine_learning/get_trained_models_stats.rb
+- lib/elasticsearch-serverless/api/machine_learning/infer_trained_model.rb
 - lib/elasticsearch-serverless/api/machine_learning/open_job.rb
 - lib/elasticsearch-serverless/api/machine_learning/post_calendar_events.rb
 - lib/elasticsearch-serverless/api/machine_learning/preview_data_frame_analytics.rb
@@ -228,6 +203,7 @@ files:
 - lib/elasticsearch-serverless/api/machine_learning/update_datafeed.rb
 - lib/elasticsearch-serverless/api/machine_learning/update_filter.rb
 - lib/elasticsearch-serverless/api/machine_learning/update_job.rb
+- lib/elasticsearch-serverless/api/machine_learning/update_trained_model_deployment.rb
 - lib/elasticsearch-serverless/api/mget.rb
 - lib/elasticsearch-serverless/api/msearch.rb
 - lib/elasticsearch-serverless/api/msearch_template.rb
@@ -235,10 +211,13 @@ files:
 - lib/elasticsearch-serverless/api/open_point_in_time.rb
 - lib/elasticsearch-serverless/api/ping.rb
 - lib/elasticsearch-serverless/api/put_script.rb
-- lib/elasticsearch-serverless/api/query_ruleset/delete.rb
-- lib/elasticsearch-serverless/api/query_ruleset/get.rb
-- lib/elasticsearch-serverless/api/query_ruleset/list.rb
-- lib/elasticsearch-serverless/api/query_ruleset/put.rb
+- lib/elasticsearch-serverless/api/query_rules/delete_rule.rb
+- lib/elasticsearch-serverless/api/query_rules/delete_ruleset.rb
+- lib/elasticsearch-serverless/api/query_rules/get_rule.rb
+- lib/elasticsearch-serverless/api/query_rules/get_ruleset.rb
+- lib/elasticsearch-serverless/api/query_rules/list_rulesets.rb
+- lib/elasticsearch-serverless/api/query_rules/put_rule.rb
+- lib/elasticsearch-serverless/api/query_rules/put_ruleset.rb
 - lib/elasticsearch-serverless/api/rank_eval.rb
 - lib/elasticsearch-serverless/api/reindex.rb
 - lib/elasticsearch-serverless/api/render_search_template.rb
@@ -262,6 +241,7 @@ files:
 - lib/elasticsearch-serverless/api/security/has_privileges.rb
 - lib/elasticsearch-serverless/api/security/invalidate_api_key.rb
 - lib/elasticsearch-serverless/api/security/query_api_keys.rb
+- lib/elasticsearch-serverless/api/security/update_api_key.rb
 - lib/elasticsearch-serverless/api/sql/clear_cursor.rb
 - lib/elasticsearch-serverless/api/sql/delete_async.rb
 - lib/elasticsearch-serverless/api/sql/get_async.rb
@@ -275,6 +255,7 @@ files:
 - lib/elasticsearch-serverless/api/synonyms/get_synonyms_sets.rb
 - lib/elasticsearch-serverless/api/synonyms/put_synonym.rb
 - lib/elasticsearch-serverless/api/synonyms/put_synonym_rule.rb
+- lib/elasticsearch-serverless/api/tasks/get.rb
 - lib/elasticsearch-serverless/api/terms_enum.rb
 - lib/elasticsearch-serverless/api/termvectors.rb
 - lib/elasticsearch-serverless/api/transform/delete_transform.rb
@@ -310,7 +291,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.11
 signing_key: 
 specification_version: 4
 summary: Elasticsearch Serverless Client