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

data/lib/opensearch/api/actions/security/delete_distinguished_names.rb

@@ -1,41 +0,0 @@
-# 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 code was generated from OpenSearch API Spec.
-# Update the code generation logic instead of modifying this file directly.
-
-# frozen_string_literal: true
-
-module OpenSearch
-  module API
-    module Security
-      module Actions
-        DELETE_DISTINGUISHED_NAMES_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
-        # Deletes all distinguished names in the specified cluster’s or node’s allow list.
-        #
-        # @option arguments [String] :cluster_name *Required*
-        #
-        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#delete-distinguished-names]
-        def delete_distinguished_names(arguments = {})
-          raise ArgumentError, "Required argument 'cluster_name' missing" unless arguments[:cluster_name]
-
-          arguments = arguments.clone
-          _cluster_name = arguments.delete(:cluster_name)
-
-          headers = arguments.delete(:headers) || {}
-          body    = arguments.delete(:body)
-          url     = Utils.__pathify '_plugins', '_security', 'api', 'nodesdn', _cluster_name
-          method  = OpenSearch::API::HTTP_DELETE
-          params  = Utils.__validate_and_extract_params arguments, DELETE_DISTINGUISHED_NAMES_QUERY_PARAMS
-
-          perform_request(method, url, params, body, headers).body
-        end
-      end
-    end
-  end
-end

data/lib/opensearch/api/actions/security/update_distinguished_names.rb

@@ -1,42 +0,0 @@
-# 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 code was generated from OpenSearch API Spec.
-# Update the code generation logic instead of modifying this file directly.
-
-# frozen_string_literal: true
-
-module OpenSearch
-  module API
-    module Security
-      module Actions
-        UPDATE_DISTINGUISHED_NAMES_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
-        # Adds or updates the specified distinguished names in the cluster’s or node’s allow list.
-        #
-        # @option arguments [String] :cluster_name *Required*
-        # @option arguments [Hash] :body
-        #
-        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#update-distinguished-names]
-        def update_distinguished_names(arguments = {})
-          raise ArgumentError, "Required argument 'cluster_name' missing" unless arguments[:cluster_name]
-
-          arguments = arguments.clone
-          _cluster_name = arguments.delete(:cluster_name)
-
-          headers = arguments.delete(:headers) || {}
-          body    = arguments.delete(:body)
-          url     = Utils.__pathify '_plugins', '_security', 'api', 'nodesdn', _cluster_name
-          method  = OpenSearch::API::HTTP_PUT
-          params  = Utils.__validate_and_extract_params arguments, UPDATE_DISTINGUISHED_NAMES_QUERY_PARAMS
-
-          perform_request(method, url, params, body, headers).body
-        end
-      end
-    end
-  end
-end

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

@@ -1,60 +0,0 @@
-# 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 Shutdown
-      module Actions
-        # Removes a node from the shutdown list
-        # 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] :node_id The node id of node to be removed from the shutdown state
-        # @option arguments [Hash] :headers Custom HTTP headers
-        #
-        #
-        def delete_node(arguments = {})
-          raise ArgumentError, "Required argument 'node_id' missing" unless arguments[:node_id]
-
-          headers = arguments.delete(:headers) || {}
-
-          arguments = arguments.clone
-
-          _node_id = arguments.delete(:node_id)
-
-          method = OpenSearch::API::HTTP_DELETE
-          path   = "_nodes/#{Utils.__listify(_node_id)}/shutdown"
-          params = {}
-
-          body = nil
-          perform_request(method, path, params, body, headers).body
-        end
-      end
-    end
-  end
-end

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

@@ -1,62 +0,0 @@
-# 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 Shutdown
-      module Actions
-        # Retrieve status of a node or nodes that are currently marked as shutting down
-        # 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] :node_id Which node for which to retrieve the shutdown status
-        # @option arguments [Hash] :headers Custom HTTP headers
-        #
-        #
-        def get_node(arguments = {})
-          headers = arguments.delete(:headers) || {}
-
-          arguments = arguments.clone
-
-          _node_id = arguments.delete(:node_id)
-
-          method = OpenSearch::API::HTTP_GET
-          path   = if _node_id
-                     "_nodes/#{Utils.__listify(_node_id)}/shutdown"
-                   else
-                     '_nodes/shutdown'
-                   end
-          params = {}
-
-          body = nil
-          perform_request(method, path, params, body, headers).body
-        end
-      end
-    end
-  end
-end

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

@@ -1,69 +0,0 @@
-# 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 Shutdown
-      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/shutdown/put_node.rb

@@ -1,62 +0,0 @@
-# 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 Shutdown
-      module Actions
-        # Adds a node to be shut down
-        # 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] :node_id The node id of node to be shut down
-        # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The shutdown type definition to register (*Required*)
-        #
-        #
-        def put_node(arguments = {})
-          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-          raise ArgumentError, "Required argument 'node_id' missing" unless arguments[:node_id]
-
-          headers = arguments.delete(:headers) || {}
-
-          arguments = arguments.clone
-
-          _node_id = arguments.delete(:node_id)
-
-          method = OpenSearch::API::HTTP_PUT
-          path   = "_nodes/#{Utils.__listify(_node_id)}/shutdown"
-          params = {}
-
-          body = arguments[:body]
-          perform_request(method, path, params, body, headers).body
-        end
-      end
-    end
-  end
-end

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

@@ -1,61 +0,0 @@
-# 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 Snapshot
-      module Actions
-        # Returns a list of features which can be snapshotted in this cluster.
-        #
-        # @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 [Hash] :headers Custom HTTP headers
-        #
-        #
-        def get_features(arguments = {})
-          headers = arguments.delete(:headers) || {}
-
-          arguments = arguments.clone
-
-          method = OpenSearch::API::HTTP_GET
-          path   = '_snapshottable_features'
-          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(:get_features, %i[
-          master_timeout
-          cluster_manager_timeout
-        ].freeze)
-      end
-    end
-  end
-end

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

@@ -1,69 +0,0 @@
-# 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 Snapshot
-      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/snapshot/repository_analyze.rb

@@ -1,84 +0,0 @@
-# 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 Snapshot
-      module Actions
-        # Analyzes a repository for correctness and performance
-        #
-        # @option arguments [String] :repository A repository name
-        # @option arguments [Number] :blob_count Number of blobs to create during the test. Defaults to 100.
-        # @option arguments [Number] :concurrency Number of operations to run concurrently during the test. Defaults to 10.
-        # @option arguments [Number] :read_node_count Number of nodes on which to read a blob after writing. Defaults to 10.
-        # @option arguments [Number] :early_read_node_count Number of nodes on which to perform an early read on a blob, i.e. before writing has completed. Early reads are rare actions so the 'rare_action_probability' parameter is also relevant. Defaults to 2.
-        # @option arguments [Number] :seed Seed for the random number generator used to create the test workload. Defaults to a random value.
-        # @option arguments [Number] :rare_action_probability Probability of taking a rare action such as an early read or an overwrite. Defaults to 0.02.
-        # @option arguments [String] :max_blob_size Maximum size of a blob to create during the test, e.g '1gb' or '100mb'. Defaults to '10mb'.
-        # @option arguments [String] :max_total_data_size Maximum total size of all blobs to create during the test, e.g '1tb' or '100gb'. Defaults to '1gb'.
-        # @option arguments [Time] :timeout Explicit operation timeout. Defaults to '30s'.
-        # @option arguments [Boolean] :detailed Whether to return detailed results or a summary. Defaults to 'false' so that only the summary is returned.
-        # @option arguments [Boolean] :rarely_abort_writes Whether to rarely abort writes before they complete. Defaults to 'true'.
-        # @option arguments [Hash] :headers Custom HTTP headers
-        #
-        #
-        def repository_analyze(arguments = {})
-          raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
-
-          headers = arguments.delete(:headers) || {}
-
-          arguments = arguments.clone
-
-          _repository = arguments.delete(:repository)
-
-          method = OpenSearch::API::HTTP_POST
-          path   = "_snapshot/#{Utils.__listify(_repository)}/_analyze"
-          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(:repository_analyze, %i[
-          blob_count
-          concurrency
-          read_node_count
-          early_read_node_count
-          seed
-          rare_action_probability
-          max_blob_size
-          max_total_data_size
-          timeout
-          detailed
-          rarely_abort_writes
-        ].freeze)
-      end
-    end
-  end
-end

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

@@ -1,69 +0,0 @@
-# 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 Tasks
-      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/namespace/cat.rb

@@ -1,47 +0,0 @@
-# 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 Cat
-      module Actions; end
-
-      # Client for the "cat" namespace (includes the {Cat::Actions} methods)
-      #
-      class CatClient
-        include Cat::Actions
-        include Common::Client::Base
-        include Common::Client
-      end
-
-      # Proxy method for {CatClient}, available in the receiving object
-      #
-      def cat
-        @cat ||= CatClient.new(self)
-      end
-    end
-  end
-end