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

data/lib/opensearch/api/actions/nodes/info.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,45 +15,30 @@ module OpenSearch
       module Actions
         # Returns information about nodes in the cluster.
         #
-        # @option arguments [List] :node_id 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] :metric A comma-separated list of metrics you wish returned. Leave empty to return all. (options: settings, os, process, jvm, thread_pool, transport, http, plugins, ingest)
-        # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
-        # @option arguments [Time] :timeout Explicit operation timeout
-        # @option arguments [Hash] :headers Custom HTTP headers
-        #
-        #
-        def info(arguments = {})
-          headers = arguments.delete(:headers) || {}
-
-          arguments = arguments.clone
+        # @option args [Boolean] :flat_settings If `true`, returns settings in flat format.
+        # @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 [Enumerable<String>, Enumerable<String>, String] :node_id_or_metric Limits the information returned to a list of node IDs or specific metrics. Supports a comma-separated list, such as `node1,node2` or `http,ingest`.
+        # @option args [Enumerable<String>] :metric Limits the information returned to the specific metrics. Supports a comma-separated list, such as `http,ingest`.
+        # @option args [Enumerable<String>, String] :node_id Comma-separated list of node IDs or names used to limit returned information.
+        def info(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          _node_id_or_metric = args.delete('node_id_or_metric')
+          _metric = args.delete('metric')
+          _node_id = args.delete('node_id')
 
-          _node_id = arguments.delete(:node_id)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = Utils.build_url('_nodes', _node_id_or_metric)
 
-          _metric = arguments.delete(:metric)
-
-          method = OpenSearch::API::HTTP_GET
-          path   = if _node_id && _metric
-                     "_nodes/#{Utils.__listify(_node_id)}/#{Utils.__listify(_metric)}"
-                   elsif _node_id
-                     "_nodes/#{Utils.__listify(_node_id)}"
-                   elsif _metric
-                     "_nodes/#{Utils.__listify(_metric)}"
-                   else
-                     '_nodes'
-                   end
-          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, INFO_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(:info, %i[
+        INFO_QUERY_PARAMS = Set.new(%w[
           flat_settings
           timeout
-        ].freeze)
+        ]).freeze
       end
     end
   end

data/lib/opensearch/api/actions/nodes/reload_secure_settings.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,37 +15,25 @@ module OpenSearch
       module Actions
         # Reloads secure settings.
         #
-        # @option arguments [List] :node_id A comma-separated list of node IDs to span the reload/reinit call. Should stay empty because reloading usually involves all cluster nodes.
-        # @option arguments [Time] :timeout Explicit operation timeout
-        # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body An object containing the password for the opensearch keystore
-        #
-        #
-        def reload_secure_settings(arguments = {})
-          headers = arguments.delete(:headers) || {}
-
-          arguments = arguments.clone
+        # @option args [Enumerable<String>, String] :node_id The names of particular nodes in the cluster to target.
+        # @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 [Hash] :body An object containing the password for the OpenSearch keystore.
+        def reload_secure_settings(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          _node_id = args.delete('node_id')
 
-          _node_id = arguments.delete(:node_id)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = Utils.build_url('_nodes', _node_id, 'reload_secure_settings')
 
-          method = OpenSearch::API::HTTP_POST
-          path   = if _node_id
-                     "_nodes/#{Utils.__listify(_node_id)}/reload_secure_settings"
-                   else
-                     '_nodes/reload_secure_settings'
-                   end
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-
-          body = arguments[:body]
-          perform_request(method, path, params, body, headers).body
+          Utils.validate_query_params! args, RELOAD_SECURE_SETTINGS_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(:reload_secure_settings, [
-          :timeout
-        ].freeze)
+        RELOAD_SECURE_SETTINGS_QUERY_PARAMS = Set.new(%w[
+          timeout
+        ]).freeze
       end
     end
   end

data/lib/opensearch/api/actions/nodes/stats.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,66 +15,42 @@ module OpenSearch
       module Actions
         # Returns statistical information about nodes in the cluster.
         #
-        # @option arguments [List] :node_id 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] :metric Limit the information returned to the specified metrics (options: _all, breaker, fs, http, indices, jvm, os, process, thread_pool, transport, discovery, indexing_pressure)
-        # @option arguments [List] :index_metric Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified. (options: _all, completion, docs, fielddata, query_cache, flush, get, indexing, merge, request_cache, refresh, search, segments, store, warmer, suggest)
-        # @option arguments [List] :completion_fields A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
-        # @option arguments [List] :fielddata_fields A comma-separated list of fields for `fielddata` index metric (supports wildcards)
-        # @option arguments [List] :fields A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)
-        # @option arguments [Boolean] :groups A comma-separated list of search groups for `search` index metric
-        # @option arguments [String] :level Return indices stats aggregated at index, node or shard level (options: indices, node, shards)
-        # @option arguments [List] :types A comma-separated list of document types for the `indexing` index metric
-        # @option arguments [Time] :timeout Explicit operation timeout
-        # @option arguments [Boolean] :include_segment_file_sizes Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested)
-        # @option arguments [Boolean] :include_unloaded_segments If set to true segment stats will include stats for segments that are not currently loaded into memory
-        # @option arguments [Hash] :headers Custom HTTP headers
-        #
-        #
-        def stats(arguments = {})
-          headers = arguments.delete(:headers) || {}
-
-          arguments = arguments.clone
-
-          _node_id = arguments.delete(:node_id)
-
-          _metric = arguments.delete(:metric)
-
-          _index_metric = arguments.delete(:index_metric)
-
-          method = OpenSearch::API::HTTP_GET
-          path   = if _node_id && _metric && _index_metric
-                     "_nodes/#{Utils.__listify(_node_id)}/stats/#{Utils.__listify(_metric)}/#{Utils.__listify(_index_metric)}"
-                   elsif _metric && _index_metric
-                     "_nodes/stats/#{Utils.__listify(_metric)}/#{Utils.__listify(_index_metric)}"
-                   elsif _node_id && _metric
-                     "_nodes/#{Utils.__listify(_node_id)}/stats/#{Utils.__listify(_metric)}"
-                   elsif _node_id
-                     "_nodes/#{Utils.__listify(_node_id)}/stats"
-                   elsif _metric
-                     "_nodes/stats/#{Utils.__listify(_metric)}"
-                   else
-                     '_nodes/stats'
-                   end
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-
-          body = nil
-          perform_request(method, path, params, body, headers).body
+        # @option args [Enumerable<String>, String] :node_id Comma-separated list of node IDs or names used to limit returned information.
+        # @option args [Enumerable<String>, String] :completion_fields Comma-separated list or wildcard expressions of fields to include in field data and suggest statistics.
+        # @option args [Enumerable<String>, String] :fielddata_fields Comma-separated list or wildcard expressions of fields to include in field data statistics.
+        # @option args [Enumerable<String>, String] :fields Comma-separated list or wildcard expressions of fields to include in the statistics.
+        # @option args [Enumerable<String>] :groups Comma-separated list of search groups to include in the search statistics.
+        # @option args [Boolean] :include_segment_file_sizes If `true`, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).
+        # @option args [String] :level Indicates whether statistics are aggregated at the cluster, index, or shard level.
+        # @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 [Enumerable<String>] :types A comma-separated list of document types for the indexing index metric.
+        # @option args [Enumerable<String>] :metric Limit the information returned to the specified metrics
+        # @option args [Enumerable<String>] :index_metric Limit the information returned for indexes metric to the specific index metrics. It can be used only if indexes (or all) metric is specified.
+        def stats(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          _node_id = args.delete('node_id')
+          _metric = args.delete('metric')
+          _index_metric = args.delete('index_metric')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = Utils.build_url('_nodes', _node_id, 'stats', _metric, _index_metric)
+
+          Utils.validate_query_params! args, STATS_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(:stats, %i[
+        STATS_QUERY_PARAMS = Set.new(%w[
           completion_fields
           fielddata_fields
           fields
           groups
+          include_segment_file_sizes
           level
-          types
           timeout
-          include_segment_file_sizes
-          include_unloaded_segments
-        ].freeze)
+          types
+        ]).freeze
       end
     end
   end

data/lib/opensearch/api/actions/nodes/usage.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,43 +15,26 @@ module OpenSearch
       module Actions
         # Returns low-level information about REST actions usage on nodes.
         #
-        # @option arguments [List] :node_id 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] :metric Limit the information returned to the specified metrics (options: _all, rest_actions)
-        # @option arguments [Time] :timeout Explicit operation timeout
-        # @option arguments [Hash] :headers Custom HTTP headers
-        #
-        #
-        def usage(arguments = {})
-          headers = arguments.delete(:headers) || {}
-
-          arguments = arguments.clone
+        # @option args [Enumerable<String>, String] :node_id 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 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 [Enumerable<String>] :metric Limits the information returned to the specific metrics. A comma-separated list of the following options: `_all`, `rest_actions`.
+        def usage(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          _node_id = args.delete('node_id')
+          _metric = args.delete('metric')
 
-          _node_id = arguments.delete(:node_id)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = Utils.build_url('_nodes', _node_id, 'usage', _metric)
 
-          _metric = arguments.delete(:metric)
-
-          method = OpenSearch::API::HTTP_GET
-          path   = if _node_id && _metric
-                     "_nodes/#{Utils.__listify(_node_id)}/usage/#{Utils.__listify(_metric)}"
-                   elsif _node_id
-                     "_nodes/#{Utils.__listify(_node_id)}/usage"
-                   elsif _metric
-                     "_nodes/usage/#{Utils.__listify(_metric)}"
-                   else
-                     '_nodes/usage'
-                   end
-          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, USAGE_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(:usage, [
-          :timeout
-        ].freeze)
+        USAGE_QUERY_PARAMS = Set.new(%w[
+          timeout
+        ]).freeze
       end
     end
   end

data/lib/opensearch/api/actions/notifications/create_config.rb

@@ -0,0 +1,34 @@
+# 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 Notifications
+      module Actions
+        # Create channel configuration.
+        #
+        # @option args [Hash] :body *Required*
+        def create_config(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = '_plugins/_notifications/configs'
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/notifications/delete_config.rb

@@ -0,0 +1,36 @@
+# 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 Notifications
+      module Actions
+        # Delete a channel configuration.
+        #
+        # @option args [String] :config_id *Required* The ID of the channel configuration to delete.
+        def delete_config(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'config_id' missing" if args['config_id'].nil?
+
+          _config_id = args.delete('config_id')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'DELETE'
+          url     = Utils.build_url('_plugins/_notifications/configs', _config_id)
+
+          Utils.validate_query_params! args
+          transport.perform_delete_request method, url, args, body, headers
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/notifications/delete_configs.rb

@@ -0,0 +1,40 @@
+# 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 Notifications
+      module Actions
+        # Delete multiple channel configurations.
+        #
+        # @option args [String] :config_id *Required* The ID of the channel configuration to delete.
+        # @option args [String] :config_id_list A comma-separated list of channel IDs to delete.
+        def delete_configs(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'config_id' missing" if args['config_id'].nil?
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'DELETE'
+          url     = '_plugins/_notifications/configs'
+
+          Utils.validate_query_params! args, DELETE_CONFIGS_QUERY_PARAMS
+          transport.perform_delete_request method, url, args, body, headers
+        end
+
+        DELETE_CONFIGS_QUERY_PARAMS = Set.new(%w[
+          config_id
+          config_id_list
+        ]).freeze
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/notifications/get_config.rb

@@ -0,0 +1,36 @@
+# 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 Notifications
+      module Actions
+        # Get a specific channel configuration.
+        #
+        # @option args [String] :config_id *Required*
+        def get_config(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'config_id' missing" if args['config_id'].nil?
+
+          _config_id = args.delete('config_id')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = Utils.build_url('_plugins/_notifications/configs', _config_id)
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end