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

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

@@ -1,88 +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 Actions
-      # Run a single query, or a set of queries, and return statistics on their performance
-      #
-      # @example Return statistics for a single query
-      #
-      #     client.benchmark body: {
-      #       name: 'my_benchmark',
-      #       competitors: [
-      #         {
-      #           name: 'query_1',
-      #           requests: [
-      #             { query: { match: { _all: 'a*' } } }
-      #           ]
-      #         }
-      #       ]
-      #     }
-      #
-      # @example Return statistics for a set of "competing" queries
-      #
-      #     client.benchmark body: {
-      #       name: 'my_benchmark',
-      #       competitors: [
-      #         {
-      #           name: 'query_a',
-      #           requests: [
-      #             { query: { match: { _all: 'a*' } } }
-      #           ]
-      #         },
-      #         {
-      #           name: 'query_b',
-      #           requests: [
-      #             { query: { match: { _all: 'b*' } } }
-      #           ]
-      #         }
-      #       ]
-      #     }
-      #
-      # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string
-      #                                 to perform the operation on all indices
-      # @option arguments [Hash] :body The search definition using the Query DSL
-      # @option arguments [Boolean] :verbose Specify whether to return verbose statistics about each iteration
-      #                                      (default: false)
-      #
-      #
-      def benchmark(arguments = {})
-        method = HTTP_PUT
-        path   = '_bench'
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body   = arguments[:body]
-
-        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(:benchmark, [:verbose].freeze)
-    end
-  end
-end

data/lib/opensearch/api/actions/cat/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 Cat
-      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/cluster/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 Cluster
-      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/dangling_indices/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 DanglingIndices
-      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/features/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 Features
-      module Actions
-        # Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot
-        #
-        # @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   = '_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/features/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 Features
-      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/features/reset_features.rb

@@ -1,55 +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 Features
-      module Actions
-        # Resets the internal state of features, usually by deleting system indices
-        # 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 [Hash] :headers Custom HTTP headers
-        #
-        #
-        def reset_features(arguments = {})
-          headers = arguments.delete(:headers) || {}
-
-          arguments = arguments.clone
-
-          method = OpenSearch::API::HTTP_POST
-          path   = '_features/_reset'
-          params = {}
-
-          body = nil
-          perform_request(method, path, params, body, headers).body
-        end
-      end
-    end
-  end
-end

data/lib/opensearch/api/actions/http/connect.rb

@@ -1,28 +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 Http
-      module Actions
-        # Make a customized CONNECT request.
-        #
-        # @option arguments [String] :url Relative path to the endpoint (e.g. 'cat/indices/books,movies') (*Required*)
-        # @option arguments [Hash] :params Querystring parameters to be appended to the path
-        # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [String | Hash | Array<Hash>] :body The body of the request
-        def connect(url, headers: {}, body: nil, params: {})
-          request('CONNECT', url, headers: headers, body: body, params: params)
-        end
-      end
-    end
-  end
-end

data/lib/opensearch/api/actions/http/delete.rb

@@ -1,28 +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 Http
-      module Actions
-        # Make a customized DELETE request.
-        #
-        # @option arguments [String] :url Relative path to the endpoint (e.g. 'cat/indices/books,movies') (*Required*)
-        # @option arguments [Hash] :params Querystring parameters to be appended to the path
-        # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [String | Hash | Array<Hash>] :body The body of the request
-        def delete(url, headers: {}, body: nil, params: {})
-          request('DELETE', url, headers: headers, body: body, params: params)
-        end
-      end
-    end
-  end
-end

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

@@ -1,28 +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 Http
-      module Actions
-        # Make a customized GET request.
-        #
-        # @option arguments [String] :url Relative path to the endpoint (e.g. 'cat/indices/books,movies') (*Required*)
-        # @option arguments [Hash] :params Querystring parameters to be appended to the path
-        # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [String | Hash | Array<Hash>] :body The body of the request
-        def get(url, headers: {}, body: nil, params: {})
-          request('GET', url, headers: headers, body: body, params: params)
-        end
-      end
-    end
-  end
-end

data/lib/opensearch/api/actions/http/head.rb

@@ -1,28 +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 Http
-      module Actions
-        # Make a customized HEAD request.
-        #
-        # @option arguments [String] :url Relative path to the endpoint (e.g. 'cat/indices/books,movies') (*Required*)
-        # @option arguments [Hash] :params Querystring parameters to be appended to the path
-        # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [String | Hash | Array<Hash>] :body The body of the request
-        def head(url, headers: {}, body: nil, params: {})
-          request('HEAD', url, headers: headers, body: body, params: params)
-        end
-      end
-    end
-  end
-end

data/lib/opensearch/api/actions/http/options.rb

@@ -1,28 +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 Http
-      module Actions
-        # Make a customized OPTIONS request.
-        #
-        # @option arguments [String] :url Relative path to the endpoint (e.g. 'cat/indices/books,movies') (*Required*)
-        # @option arguments [Hash] :params Querystring parameters to be appended to the path
-        # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [String | Hash | Array<Hash>] :body The body of the request
-        def options(url, headers: {}, body: nil, params: {})
-          request('OPTIONS', url, headers: headers, body: body, params: params)
-        end
-      end
-    end
-  end
-end

data/lib/opensearch/api/actions/http/patch.rb

@@ -1,28 +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 Http
-      module Actions
-        # Make a customized PATCH request.
-        #
-        # @option arguments [String] :url Relative path to the endpoint (e.g. 'cat/indices/books,movies') (*Required*)
-        # @option arguments [Hash] :params Querystring parameters to be appended to the path
-        # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [String | Hash | Array<Hash>] :body The body of the request
-        def patch(url, headers: {}, body: nil, params: {})
-          request('PATCH', url, headers: headers, body: body, params: params)
-        end
-      end
-    end
-  end
-end

data/lib/opensearch/api/actions/http/post.rb

@@ -1,28 +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 Http
-      module Actions
-        # Make a customized POST request.
-        #
-        # @option arguments [String] :url Relative path to the endpoint (e.g. 'cat/indices/books,movies') (*Required*)
-        # @option arguments [Hash] :params Querystring parameters to be appended to the path
-        # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [String | Hash | Array<Hash>] :body The body of the request
-        def post(url, headers: {}, body: nil, params: {})
-          request('POST', url, headers: headers, body: body, params: params)
-        end
-      end
-    end
-  end
-end