elasticsearch-serverless 0.4.0 → 0.6.0

data/lib/elasticsearch-serverless/api/security/put_role.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 Security
+      module Actions
+        # Create or update roles.
+        # The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management.
+        # The create or update roles API cannot update roles that are defined in roles files.
+        # File-based role management is not available in Elastic Serverless.
+        #
+        # @option arguments [String] :name The name of the role that is being created or updated. On Elasticsearch Serverless, the role name must begin with a letter or digit and can only contain letters, digits and the characters '_', '-', and '.'. Each role must have a unique name, as this will serve as the identifier for that role. (*Required*)
+        # @option arguments [String] :refresh If +true+ (the default) then refresh the affected shards to make this operation visible to search, if +wait_for+ then wait for a refresh to make this operation visible to search, if +false+ then do nothing with refreshes.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body request body
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html
+        #
+        def put_role(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || "security.put_role" }
+
+          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   = "_security/role/#{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/security/query_api_keys.rb

@@ -22,8 +22,8 @@ module ElasticsearchServerless
   module API
     module Security
       module Actions
-        # Query API keys.
-        # Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query.
+        # Find API keys with a query.
+        # Get a paginated list of API keys and their information. You can optionally filter the results with a query.
         #
         # @option arguments [Boolean] :with_limited_by Return the snapshot of the owner user's role descriptors associated with the API key.
         #  An API key's actual permission is the intersection of its assigned role descriptors and the owner user's role descriptors.

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

@@ -0,0 +1,69 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# Auto generated from commit f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch-specification
+#
+module ElasticsearchServerless
+  module API
+    module Tasks
+      module Actions
+        # Get task information.
+        # Returns information about the tasks currently executing in the cluster.
+        # This functionality is Experimental and may be changed or removed
+        # completely in a future release. Elastic will take a best effort approach
+        # to fix any issues, but experimental features are not subject to the
+        # support SLA of official GA features.
+        #
+        # @option arguments [String] :task_id ID of the task. (*Required*)
+        # @option arguments [Time] :timeout Period to wait for a response.
+        #  If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
+        # @option arguments [Boolean] :wait_for_completion If +true+, the request blocks until the task has completed.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html
+        #
+        def get(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || "tasks.get" }
+
+          defined_params = [:task_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 'task_id' missing" unless arguments[:task_id]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          _task_id = arguments.delete(:task_id)
+
+          method = ElasticsearchServerless::API::HTTP_GET
+          path   = "_tasks/#{Utils.listify(_task_id)}"
+          params = Utils.process_params(arguments)
+
+          ElasticsearchServerless::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -21,7 +21,12 @@
 module ElasticsearchServerless
   module API
     module Actions
-      # The terms enum API  can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios.
+      # Get terms in an index.
+      # Discover terms that match a partial string in an index.
+      # This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios.
+      # If the +complete+ property in the response is false, the returned terms set may be incomplete and should be treated as approximate.
+      # This can occur due to a few reasons, such as a request timeout or a node error.
+      # NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents.
       #
       # @option arguments [String] :index Comma-separated list of data streams, indices, and index aliases to search. Wildcard (*) expressions are supported. (*Required*)
       # @option arguments [Hash] :headers Custom HTTP headers

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

@@ -22,7 +22,7 @@ module ElasticsearchServerless
   module API
     module Actions
       # Get term vector information.
-      # Returns information and statistics about terms in the fields of a particular document.
+      # Get information and statistics about terms in the fields of a particular document.
       #
       # @option arguments [String] :index Name of the index that contains the document. (*Required*)
       # @option arguments [String] :id Unique identifier of the document.

data/lib/elasticsearch-serverless/api.rb

@@ -74,6 +74,7 @@ module ElasticsearchServerless
       :security,
       :sql,
       :synonyms,
+      :tasks,
       :transform
     ].freeze
     UPPERCASE_APIS = ['sql'].freeze

data/lib/elasticsearch-serverless/version.rb

@@ -17,6 +17,6 @@
 
 module ElasticsearchServerless
   API_VERSION = '2023-10-31'.freeze
-  CLIENT_VERSION = '0.4.0'.freeze
+  CLIENT_VERSION = '0.6.0'.freeze
   VERSION = CLIENT_VERSION
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-serverless
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Fernando Briano
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-02 00:00:00.000000000 Z
+date: 2024-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elastic-transport
@@ -87,7 +87,6 @@ files:
 - lib/elasticsearch-serverless/api/enrich/execute_policy.rb
 - lib/elasticsearch-serverless/api/enrich/get_policy.rb
 - lib/elasticsearch-serverless/api/enrich/put_policy.rb
-- lib/elasticsearch-serverless/api/enrich/stats.rb
 - lib/elasticsearch-serverless/api/eql/delete.rb
 - lib/elasticsearch-serverless/api/eql/get.rb
 - lib/elasticsearch-serverless/api/eql/get_status.rb
@@ -107,7 +106,6 @@ files:
 - lib/elasticsearch-serverless/api/indices/create_data_stream.rb
 - lib/elasticsearch-serverless/api/indices/delete.rb
 - lib/elasticsearch-serverless/api/indices/delete_alias.rb
-- lib/elasticsearch-serverless/api/indices/delete_data_lifecycle.rb
 - lib/elasticsearch-serverless/api/indices/delete_data_stream.rb
 - lib/elasticsearch-serverless/api/indices/delete_index_template.rb
 - lib/elasticsearch-serverless/api/indices/exists.rb
@@ -174,6 +172,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
@@ -214,6 +213,7 @@ files:
 - 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/query_rules/test.rb
 - lib/elasticsearch-serverless/api/rank_eval.rb
 - lib/elasticsearch-serverless/api/reindex.rb
 - lib/elasticsearch-serverless/api/render_search_template.rb
@@ -233,9 +233,13 @@ files:
 - lib/elasticsearch-serverless/api/search_template.rb
 - lib/elasticsearch-serverless/api/security/authenticate.rb
 - lib/elasticsearch-serverless/api/security/create_api_key.rb
+- lib/elasticsearch-serverless/api/security/delete_role.rb
 - lib/elasticsearch-serverless/api/security/get_api_key.rb
+- lib/elasticsearch-serverless/api/security/get_builtin_privileges.rb
+- lib/elasticsearch-serverless/api/security/get_role.rb
 - lib/elasticsearch-serverless/api/security/has_privileges.rb
 - lib/elasticsearch-serverless/api/security/invalidate_api_key.rb
+- lib/elasticsearch-serverless/api/security/put_role.rb
 - lib/elasticsearch-serverless/api/security/query_api_keys.rb
 - lib/elasticsearch-serverless/api/sql/clear_cursor.rb
 - lib/elasticsearch-serverless/api/sql/delete_async.rb
@@ -250,6 +254,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
@@ -285,7 +290,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.5.20
 signing_key:
 specification_version: 4
 summary: Elasticsearch Serverless Client