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

data/lib/opensearch/api/actions/indices/disk_usage.rb

@@ -1,76 +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 Indices
-      module Actions
-        # Analyzes the disk usage of each field of an index or data stream
-        # 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] :index Comma-separated list of indices or data streams to analyze the disk usage
-        # @option arguments [Boolean] :run_expensive_tasks Must be set to [true] in order for the task to be performed. Defaults to false.
-        # @option arguments [Boolean] :flush Whether flush or not before analyzing the index disk usage. Defaults to true
-        # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
-        # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
-        # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
-        # @option arguments [Hash] :headers Custom HTTP headers
-        #
-        #
-        def disk_usage(arguments = {})
-          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
-
-          headers = arguments.delete(:headers) || {}
-
-          arguments = arguments.clone
-
-          _index = arguments.delete(:index)
-
-          method = OpenSearch::API::HTTP_POST
-          path   = "#{Utils.__listify(_index)}/_disk_usage"
-          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(:disk_usage, %i[
-          run_expensive_tasks
-          flush
-          ignore_unavailable
-          allow_no_indices
-          expand_wildcards
-        ].freeze)
-      end
-    end
-  end
-end

data/lib/opensearch/api/actions/indices/field_usage_stats.rb

@@ -1,74 +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 Indices
-      module Actions
-        # Returns the field usage stats for each field of an index
-        # 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] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
-        # @option arguments [List] :fields A comma-separated list of fields to include in the stats if only a subset of fields should be returned (supports wildcards)
-        # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
-        # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
-        # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
-        # @option arguments [Hash] :headers Custom HTTP headers
-        #
-        #
-        def field_usage_stats(arguments = {})
-          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
-
-          headers = arguments.delete(:headers) || {}
-
-          arguments = arguments.clone
-
-          _index = arguments.delete(:index)
-
-          method = OpenSearch::API::HTTP_GET
-          path   = "#{Utils.__listify(_index)}/_field_usage_stats"
-          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(:field_usage_stats, %i[
-          fields
-          ignore_unavailable
-          allow_no_indices
-          expand_wildcards
-        ].freeze)
-      end
-    end
-  end
-end

data/lib/opensearch/api/actions/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 Indices
-      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/ingest/geo_ip_stats.rb

@@ -1,51 +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 Ingest
-      module Actions
-        # Returns statistical information about geoip databases
-        #
-        # @option arguments [Hash] :headers Custom HTTP headers
-        #
-        #
-        def geo_ip_stats(arguments = {})
-          headers = arguments.delete(:headers) || {}
-
-          arguments = arguments.clone
-
-          method = OpenSearch::API::HTTP_GET
-          path   = '_ingest/geoip/stats'
-          params = {}
-
-          body = nil
-          perform_request(method, path, params, body, headers).body
-        end
-      end
-    end
-  end
-end

data/lib/opensearch/api/actions/ingest/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 Ingest
-      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/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 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/shutdown.rb

@@ -1,65 +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 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/params_registry.rb

@@ -1,67 +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
-      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/remote/info.rb

@@ -1,45 +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 Remote
-      module Actions
-        # Returns all of the configured remote cluster information
-        #
-        #
-        def info(_arguments = {})
-          method = HTTP_GET
-          path   = '_remote/info'
-          params = {}
-          body   = nil
-
-          perform_request(method, path, params, body).body
-        end
-      end
-    end
-  end
-end

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