opensearch-ruby 3.4.0 → 4.0.0.pre.beta.2

data/lib/opensearch/api/actions/snapshot/verify_repository.rb

@@ -3,26 +3,11 @@
 # The OpenSearch Contributors require contributions made to
 # this file be licensed under the Apache-2.0 license or a
 # compatible open source license.
-#
-# Modifications Copyright OpenSearch Contributors. See
-# GitHub history for details.
-#
-# 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.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
 
 module OpenSearch
   module API
@@ -30,38 +15,30 @@ module OpenSearch
       module Actions
         # Verifies a repository.
         #
-        # @option arguments [String] :repository A repository name
-        # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node
-        # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node
-        # @option arguments [Time] :timeout Explicit operation timeout
-        # @option arguments [Hash] :headers Custom HTTP headers
-        #
-        #
-        def verify_repository(arguments = {})
-          raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
-
-          headers = arguments.delete(:headers) || {}
-
-          arguments = arguments.clone
+        # @option args [String] :repository *Required* A repository name
+        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
+        # @option args [String] :master_timeout DEPRECATED Explicit operation timeout for connection to cluster-manager node
+        # @option args [String] :timeout Explicit operation timeout
+        def verify_repository(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'repository' missing" if args['repository'].nil?
 
-          _repository = arguments.delete(:repository)
+          _repository = args.delete('repository')
 
-          method = OpenSearch::API::HTTP_POST
-          path   = "_snapshot/#{Utils.__listify(_repository)}/_verify"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = Utils.build_url('_snapshot', _repository, '_verify')
 
-          body = nil
-          perform_request(method, path, params, body, headers).body
+          Utils.validate_query_params! args, VERIFY_REPOSITORY_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
         end
 
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:verify_repository, %i[
-          master_timeout
+        VERIFY_REPOSITORY_QUERY_PARAMS = Set.new(%w[
           cluster_manager_timeout
+          master_timeout
           timeout
-        ].freeze)
+        ]).freeze
       end
     end
   end

data/lib/opensearch/api/actions/sql/close.rb

@@ -0,0 +1,39 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Sql
+      module Actions
+        # Clear the cursor context.
+        #
+        # @option args [String] :format A short version of the Accept header (for example, `json`, `yaml`).
+        # @option args [Boolean] :sanitize (default: true) Specifies whether to escape special characters in the results
+        # @option args [Hash] :body
+        def close(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = '_plugins/_sql/close'
+
+          Utils.validate_query_params! args, CLOSE_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        CLOSE_QUERY_PARAMS = Set.new(%w[
+          format
+          sanitize
+        ]).freeze
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/sql/explain.rb

@@ -0,0 +1,39 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Sql
+      module Actions
+        # Shows how a query is executed against OpenSearch.
+        #
+        # @option args [String] :format A short version of the Accept header (for example, `json`, `yaml`).
+        # @option args [Boolean] :sanitize (default: true) Specifies whether to escape special characters in the results
+        # @option args [Hash] :body
+        def explain(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = '_plugins/_sql/_explain'
+
+          Utils.validate_query_params! args, EXPLAIN_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        EXPLAIN_QUERY_PARAMS = Set.new(%w[
+          format
+          sanitize
+        ]).freeze
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/sql/get_stats.rb

@@ -0,0 +1,38 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Sql
+      module Actions
+        # Collect metrics for the plugin within the interval.
+        #
+        # @option args [String] :format A short version of the Accept header (for example, `json`, `yaml`).
+        # @option args [Boolean] :sanitize (default: true) Specifies whether to escape special characters in the results
+        def get_stats(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_plugins/_sql/stats'
+
+          Utils.validate_query_params! args, GET_STATS_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        GET_STATS_QUERY_PARAMS = Set.new(%w[
+          format
+          sanitize
+        ]).freeze
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/sql/post_stats.rb

@@ -0,0 +1,39 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Sql
+      module Actions
+        # By a stats endpoint, you are able to collect metrics for the plugin within the interval.
+        #
+        # @option args [String] :format A short version of the Accept header (for example, `json`, `yaml`).
+        # @option args [Boolean] :sanitize (default: true) Specifies whether to escape special characters in the results
+        # @option args [Hash] :body
+        def post_stats(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = '_plugins/_sql/stats'
+
+          Utils.validate_query_params! args, POST_STATS_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        POST_STATS_QUERY_PARAMS = Set.new(%w[
+          format
+          sanitize
+        ]).freeze
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/sql/query.rb

@@ -0,0 +1,39 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Sql
+      module Actions
+        # Send a SQL/PPL query to the SQL plugin.
+        #
+        # @option args [String] :format A short version of the Accept header (for example, `json`, `yaml`).
+        # @option args [Boolean] :sanitize (default: true) Specifies whether to escape special characters in the results
+        # @option args [Hash] :body
+        def query(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = '_plugins/_sql'
+
+          Utils.validate_query_params! args, QUERY_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        QUERY_QUERY_PARAMS = Set.new(%w[
+          format
+          sanitize
+        ]).freeze
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/sql/settings.rb

@@ -0,0 +1,37 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Sql
+      module Actions
+        # Adds SQL settings to the standard OpenSearch cluster settings.
+        #
+        # @option args [String] :format A short version of the Accept header (for example, `json`, `yaml`).
+        # @option args [Hash] :body
+        def settings(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'PUT'
+          url     = '_plugins/_query/settings'
+
+          Utils.validate_query_params! args, SETTINGS_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        SETTINGS_QUERY_PARAMS = Set.new(%w[
+          format
+        ]).freeze
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/tasks/cancel.rb

@@ -3,73 +3,42 @@
 # The OpenSearch Contributors require contributions made to
 # this file be licensed under the Apache-2.0 license or a
 # compatible open source license.
-#
-# Modifications Copyright OpenSearch Contributors. See
-# GitHub history for details.
-#
-# 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.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
 
 module OpenSearch
   module API
     module Tasks
       module Actions
         # Cancels a task, if it can be cancelled through an API.
-        # This functionality is Experimental and may be changed or removed
-        # completely in a future release. OpenSearch 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 Cancel the task with specified task id (node_id:task_number)
-        # @option arguments [List] :nodes A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
-        # @option arguments [List] :actions A comma-separated list of actions that should be cancelled. Leave empty to cancel all.
-        # @option arguments [String] :parent_task_id Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all.
-        # @option arguments [Boolean] :wait_for_completion Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false
-        # @option arguments [Hash] :headers Custom HTTP headers
         #
-        #
-        def cancel(arguments = {})
-          headers = arguments.delete(:headers) || {}
-
-          arguments = arguments.clone
-
-          _task_id = arguments.delete(:task_id)
+        # @option args [Enumerable<String>, String] :actions Comma-separated list or wildcard expression of actions used to limit the request.
+        # @option args [Enumerable<String>] :nodes Comma-separated list of node IDs or names used to limit the request.
+        # @option args [String] :parent_task_id Parent task ID used to limit the tasks.
+        # @option args [Boolean] :wait_for_completion Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false
+        # @option args [String] :task_id ID of the task.
+        def cancel(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          _task_id = args.delete('task_id')
 
-          method = OpenSearch::API::HTTP_POST
-          path   = if _task_id
-                     "_tasks/#{Utils.__listify(_task_id)}/_cancel"
-                   else
-                     '_tasks/_cancel'
-                   end
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = Utils.build_url('_tasks', _task_id, '_cancel')
 
-          body = nil
-          perform_request(method, path, params, body, headers).body
+          Utils.validate_query_params! args, CANCEL_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
         end
 
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:cancel, %i[
-          nodes
+        CANCEL_QUERY_PARAMS = Set.new(%w[
           actions
+          nodes
           parent_task_id
           wait_for_completion
-        ].freeze)
+        ]).freeze
       end
     end
   end

data/lib/opensearch/api/actions/tasks/get.rb

@@ -3,65 +3,40 @@
 # The OpenSearch Contributors require contributions made to
 # this file be licensed under the Apache-2.0 license or a
 # compatible open source license.
-#
-# Modifications Copyright OpenSearch Contributors. See
-# GitHub history for details.
-#
-# 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.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
 
 module OpenSearch
   module API
     module Tasks
       module Actions
         # Returns information about a task.
-        # This functionality is Experimental and may be changed or removed
-        # completely in a future release. OpenSearch 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 Return the task with specified id (node_id:task_number)
-        # @option arguments [Boolean] :wait_for_completion Wait for the matching tasks to complete (default: false)
-        # @option arguments [Time] :timeout Explicit operation timeout
-        # @option arguments [Hash] :headers Custom HTTP headers
-        #
-        #
-        def get(arguments = {})
-          headers = arguments.delete(:headers) || {}
-
-          arguments = arguments.clone
+        # @option args [String] :task_id *Required* ID of the task.
+        # @option args [String] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
+        # @option args [Boolean] :wait_for_completion If `true`, the request blocks until the task has completed.
+        def get(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'task_id' missing" if args['task_id'].nil?
 
-          _task_id = arguments.delete(:task_id)
+          _task_id = args.delete('task_id')
 
-          method = OpenSearch::API::HTTP_GET
-          path   = "_tasks/#{Utils.__listify(_task_id)}"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = Utils.build_url('_tasks', _task_id)
 
-          body = nil
-          perform_request(method, path, params, body, headers).body
+          Utils.validate_query_params! args, GET_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
         end
 
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:get, %i[
-          wait_for_completion
+        GET_QUERY_PARAMS = Set.new(%w[
           timeout
-        ].freeze)
+          wait_for_completion
+        ]).freeze
       end
     end
   end

data/lib/opensearch/api/actions/tasks/list.rb

@@ -3,72 +3,45 @@
 # The OpenSearch Contributors require contributions made to
 # this file be licensed under the Apache-2.0 license or a
 # compatible open source license.
-#
-# Modifications Copyright OpenSearch Contributors. See
-# GitHub history for details.
-#
-# 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.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
 
 module OpenSearch
   module API
     module Tasks
       module Actions
         # Returns a list of tasks.
-        # This functionality is Experimental and may be changed or removed
-        # completely in a future release. OpenSearch 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 [List] :nodes A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
-        # @option arguments [List] :actions A comma-separated list of actions that should be returned. Leave empty to return all.
-        # @option arguments [Boolean] :detailed Return detailed task information (default: false)
-        # @option arguments [String] :parent_task_id Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all.
-        # @option arguments [Boolean] :wait_for_completion Wait for the matching tasks to complete (default: false)
-        # @option arguments [String] :group_by Group tasks by nodes or parent/child relationships (options: nodes, parents, none)
-        # @option arguments [Time] :timeout Explicit operation timeout
-        # @option arguments [Hash] :headers Custom HTTP headers
         #
-        #
-        def list(arguments = {})
-          headers = arguments.delete(:headers) || {}
-
-          arguments = arguments.clone
+        # @option args [Enumerable<String>, String] :actions Comma-separated list or wildcard expression of actions used to limit the request.
+        # @option args [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries.
+        # @option args [String] :group_by Key used to group tasks in the response.
+        # @option args [Enumerable<String>] :nodes Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.
+        # @option args [String] :parent_task_id Parent task ID used to limit returned information. To return all tasks, omit this parameter or use a value of `-1`.
+        # @option args [String] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
+        # @option args [Boolean] :wait_for_completion If `true`, the request blocks until the operation is complete.
+        def list(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_tasks'
 
-          method = OpenSearch::API::HTTP_GET
-          path   = '_tasks'
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-
-          body = nil
-          perform_request(method, path, params, body, headers).body
+          Utils.validate_query_params! args, LIST_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
         end
 
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:list, %i[
-          nodes
+        LIST_QUERY_PARAMS = Set.new(%w[
           actions
           detailed
-          parent_task_id
-          wait_for_completion
           group_by
+          nodes
+          parent_task_id
           timeout
-        ].freeze)
+          wait_for_completion
+        ]).freeze
       end
     end
   end