elasticsearch-api 7.13.3 → 8.14.0

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

@@ -1,81 +0,0 @@
-# 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 Elasticsearch
-  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 [String] :type The name of the document type
-      # @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)
-      #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/search-benchmark.html
-      #
-      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/elasticsearch/api/actions/cat/params_registry.rb

@@ -1,60 +0,0 @@
-# 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 Elasticsearch
-  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/elasticsearch/api/actions/cluster/params_registry.rb

@@ -1,60 +0,0 @@
-# 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 Elasticsearch
-  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/elasticsearch/api/actions/dangling_indices/params_registry.rb

@@ -1,60 +0,0 @@
-# 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 Elasticsearch
-  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/elasticsearch/api/actions/delete_by_rethrottle.rb

@@ -1,47 +0,0 @@
-# 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 Elasticsearch
-  module API
-    module Actions
-      # The value of requests_per_second can be changed on a running delete by query using the _rethrottle API
-      #
-      # @option arguments [String] :task_id The task id to rethrottle (*Required*)
-      # @option arguments [Number] :requests_per_second The throttle to set on this request in floating sub-requests per second. -1 means set no throttle.
-      #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html
-      #
-      def delete_by_query_rethrottle(arguments = {})
-        raise ArgumentError, "Required argument 'task_id' missing" unless arguments[:task_id]
-
-        method = Elasticsearch::API::HTTP_POST
-        path   = "_delete_by_query/#{arguments[:task_id]}/_rethrottle"
-        params = Elasticsearch::API::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.2.0
-      ParamsRegistry.register(:delete_by_query_rethrottle, [
-        :requests_per_second
-      ].freeze)
-    end
-  end
-end

data/lib/elasticsearch/api/actions/features/params_registry.rb

@@ -1,60 +0,0 @@
-# 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 Elasticsearch
-  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/elasticsearch/api/actions/indices/params_registry.rb

@@ -1,60 +0,0 @@
-# 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 Elasticsearch
-  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/elasticsearch/api/actions/ingest/params_registry.rb

@@ -1,60 +0,0 @@
-# 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 Elasticsearch
-  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/elasticsearch/api/actions/nodes/params_registry.rb

@@ -1,60 +0,0 @@
-# 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 Elasticsearch
-  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/elasticsearch/api/actions/nodes/shutdown.rb

@@ -1,56 +0,0 @@
-# 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 Elasticsearch
-  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://elasticsearch.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, [
-          :delay,
-          :exit
-        ].freeze)
-      end
-    end
-  end
-end

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

@@ -1,58 +0,0 @@
-# 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 Elasticsearch
-  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