opensearch-ruby 2.0.3 → 3.4.0

data/lib/opensearch/api/actions/nodes/info.rb

@@ -0,0 +1,75 @@
+# 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.
+#
+# 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.
+
+module OpenSearch
+  module API
+    module Nodes
+      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
+
+          _node_id = arguments.delete(:node_id)
+
+          _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
+        end
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.2.0
+        ParamsRegistry.register(:info, %i[
+          flat_settings
+          timeout
+        ].freeze)
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/nodes/params_registry.rb

@@ -0,0 +1,69 @@
+# 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.
+#
+# 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.
+
+module OpenSearch
+  module API
+    module Nodes
+      module Actions
+        module ParamsRegistry
+          extend self
+
+          # A Mapping of all the actions to their list of valid params.
+          #
+          # @since 6.1.1
+          PARAMS = {}
+
+          # Register an action with its list of valid params.
+          #
+          # @example Register the action.
+          #   ParamsRegistry.register(:benchmark, [ :verbose ])
+          #
+          # @param [ Symbol ] action The action to register.
+          # @param [ Array[Symbol] ] valid_params The list of valid params.
+          #
+          # @since 6.1.1
+          def register(action, valid_params)
+            PARAMS[action.to_sym] = valid_params
+          end
+
+          # Get the list of valid params for a given action.
+          #
+          # @example Get the list of valid params.
+          #   ParamsRegistry.get(:benchmark)
+          #
+          # @param [ Symbol ] action The action.
+          #
+          # @return [ Array<Symbol> ] The list of valid params for the action.
+          #
+          # @since 6.1.1
+          def get(action)
+            PARAMS.fetch(action, [])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/nodes/reload_secure_settings.rb

@@ -0,0 +1,67 @@
+# 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.
+#
+# 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.
+
+module OpenSearch
+  module API
+    module Nodes
+      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
+
+          _node_id = arguments.delete(:node_id)
+
+          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
+        end
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.2.0
+        ParamsRegistry.register(:reload_secure_settings, [
+          :timeout
+        ].freeze)
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/nodes/shutdown.rb

@@ -0,0 +1,65 @@
+# 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.
+#
+# 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.
+
+module OpenSearch
+  module API
+    module Nodes
+      module Actions
+        # Shutdown one or all nodes
+        #
+        # @example Shut down node named _Bloke_
+        #
+        #     client.nodes.shutdown node_id: 'Bloke'
+        #
+        # @option arguments [List] :node_id A comma-separated list of node IDs or names to perform the operation on; use
+        #                                   `_local` to shutdown the node you're connected to, leave empty to
+        #                                   shutdown all nodes
+        # @option arguments [Time] :delay Set the delay for the operation (default: 1s)
+        # @option arguments [Boolean] :exit Exit the JVM as well (default: true)
+        #
+        # @see http://opensearch.org/guide/reference/api/admin-cluster-nodes-shutdown/
+        #
+        def shutdown(arguments = {})
+          method = HTTP_POST
+          path   = Utils.__pathify '_cluster/nodes', Utils.__listify(arguments[:node_id]), '_shutdown'
+
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          body   = nil
+
+          perform_request(method, path, params, body).body
+        end
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.1.1
+        ParamsRegistry.register(:shutdown, %i[
+          delay
+          exit
+        ].freeze)
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/nodes/stats.rb

@@ -0,0 +1,96 @@
+# 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.
+#
+# 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.
+
+module OpenSearch
+  module API
+    module Nodes
+      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
+        end
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.2.0
+        ParamsRegistry.register(:stats, %i[
+          completion_fields
+          fielddata_fields
+          fields
+          groups
+          level
+          types
+          timeout
+          include_segment_file_sizes
+          include_unloaded_segments
+        ].freeze)
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/nodes/usage.rb

@@ -0,0 +1,73 @@
+# 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.
+#
+# 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.
+
+module OpenSearch
+  module API
+    module Nodes
+      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
+
+          _node_id = arguments.delete(:node_id)
+
+          _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
+        end
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.2.0
+        ParamsRegistry.register(:usage, [
+          :timeout
+        ].freeze)
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/params_registry.rb

@@ -0,0 +1,67 @@
+# 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.
+#
+# 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.
+
+module OpenSearch
+  module API
+    module Actions
+      module ParamsRegistry
+        extend self
+
+        # A Mapping of all the actions to their list of valid params.
+        #
+        # @since 6.1.1
+        PARAMS = {}
+
+        # Register an action with its list of valid params.
+        #
+        # @example Register the action.
+        #   ParamsRegistry.register(:benchmark, [ :verbose ])
+        #
+        # @param [ Symbol ] action The action to register.
+        # @param [ Array[Symbol] ] valid_params The list of valid params.
+        #
+        # @since 6.1.1
+        def register(action, valid_params)
+          PARAMS[action.to_sym] = valid_params
+        end
+
+        # Get the list of valid params for a given action.
+        #
+        # @example Get the list of valid params.
+        #   ParamsRegistry.get(:benchmark)
+        #
+        # @param [ Symbol ] action The action.
+        #
+        # @return [ Array<Symbol> ] The list of valid params for the action.
+        #
+        # @since 6.1.1
+        def get(action)
+          PARAMS.fetch(action, [])
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/ping.rb

@@ -0,0 +1,54 @@
+# 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.
+#
+# 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.
+
+module OpenSearch
+  module API
+    module Actions
+      # Returns whether the cluster is running.
+      #
+      # @option arguments [Hash] :headers Custom HTTP headers
+      #
+      #
+      def ping(arguments = {})
+        headers = arguments.delete(:headers) || {}
+
+        arguments = arguments.clone
+
+        method = OpenSearch::API::HTTP_HEAD
+        path   = ''
+        params = {}
+
+        body = nil
+        begin
+          perform_request(method, path, params, body, headers).status == 200
+        rescue StandardError => e
+          raise e unless e.class.to_s =~ /NotFound|ConnectionFailed/ || e.message =~ /Not *Found|404|ConnectionFailed/i
+          false
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/put_script.rb

@@ -0,0 +1,76 @@
+# 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.
+#
+# 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.
+
+module OpenSearch
+  module API
+    module Actions
+      # Creates or updates a script.
+      #
+      # @option arguments [String] :id Script ID
+      # @option arguments [String] :context Script context
+      # @option arguments [Time] :timeout Explicit operation timeout
+      # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master
+      # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager
+      # @option arguments [Hash] :headers Custom HTTP headers
+      # @option arguments [Hash] :body The document (*Required*)
+      #
+      #
+      def put_script(arguments = {})
+        raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+        raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+
+        headers = arguments.delete(:headers) || {}
+
+        arguments = arguments.clone
+
+        _id = arguments.delete(:id)
+
+        _context = arguments.delete(:context)
+
+        method = OpenSearch::API::HTTP_PUT
+        path   = if _id && _context
+                   "_scripts/#{Utils.__listify(_id)}/#{Utils.__listify(_context)}"
+                 else
+                   "_scripts/#{Utils.__listify(_id)}"
+                 end
+        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+
+        body = arguments[:body]
+        perform_request(method, path, params, body, headers).body
+      end
+
+      # Register this action with its valid params when the module is loaded.
+      #
+      # @since 6.2.0
+      ParamsRegistry.register(:put_script, %i[
+        timeout
+        master_timeout
+        cluster_manager_timeout
+        context
+      ].freeze)
+    end
+  end
+end