elasticsearch-api 7.2.0 → 8.0.0

data/lib/elasticsearch/api/actions/cluster/get_component_template.rb

@@ -0,0 +1,55 @@
+# 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
+        # Returns one or more component templates
+        #
+        # @option arguments [List] :name The comma separated names of the component templates
+        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html
+        #
+        def get_component_template(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _name = arguments.delete(:name)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _name
+                     "_component_template/#{Utils.__listify(_name)}"
+                   else
+                     "_component_template"
+                   end
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/cluster/get_settings.rb

@@ -6,7 +6,7 @@
 # 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
+#   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
@@ -19,36 +19,31 @@ module Elasticsearch
   module API
     module Cluster
       module Actions
-
-        # Get the cluster settings (previously set with {Cluster::Actions#put_settings})
-        #
-        # @example Get cluster settings
-        #
-        #     client.cluster.get_settings
+        # Returns cluster settings.
         #
         # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
-        # @option arguments [Boolean] :include_defaults Whether to return all default clusters setting
-        #                                               (default: false)
+        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [Boolean] :include_defaults Whether to return all default clusters setting.
+        # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see http://elasticsearch.org/guide/reference/api/admin-cluster-update-settings/
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-get-settings.html
         #
-        def get_settings(arguments={})
-          method = HTTP_GET
+        def get_settings(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          method = Elasticsearch::API::HTTP_GET
           path   = "_cluster/settings"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
+          params = Utils.process_params(arguments)
 
-          perform_request(method, path, params, body).body
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.1.1
-        ParamsRegistry.register(:get_settings, [
-            :flat_settings,
-            :master_timeout,
-            :timeout,
-            :include_defaults ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/cluster/health.rb

@@ -6,7 +6,7 @@
 # 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
+#   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
@@ -19,66 +19,45 @@ module Elasticsearch
   module API
     module Cluster
       module Actions
-
-        # Returns information about cluster "health".
-        #
-        # @example Get the cluster health information
-        #
-        #     client.cluster.health
+        # Returns basic information about the health of the cluster.
         #
-        # @example Block the request until the cluster is in the "yellow" state
-        #
-        #     client.cluster.health wait_for_status: 'yellow'
-        #
-        # @option arguments [String] :index Limit the information returned to a specific index
-        # @option arguments [String] :level Specify the level of detail for returned information
-        #                                   (options: cluster, indices, shards)
-        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
-        #                                    (default: false)
+        # @option arguments [List] :index Limit the information returned to a specific index
+        # @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 [String] :level Specify the level of detail for returned information (options: cluster, indices, shards)
+        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         # @option arguments [Time] :timeout Explicit operation timeout
-        # @option arguments [Number] :wait_for_active_shards Wait until the specified number of shards is active
-        # @option arguments [Number] :wait_for_nodes Wait until the specified number of nodes is available
-        # @option arguments [Number] :wait_for_relocating_shards Wait until the specified number of relocating
-        #                                                        shards is finished
-        # @option arguments [Boolean] :wait_for_no_relocating_shards Whether to wait until there are no relocating
-        #                                                            shards in the cluster
-        # @option arguments [Boolean] :wait_for_no_initializing_shards Whether to wait until there are no
-        #                                                              initializing shards in the cluster
-        # @option arguments [String] :wait_for_status Wait until cluster is in a specific state
-        #                                             (options: green, yellow, red)
-        # @option arguments [List] :wait_for_events Wait until all currently queued events with the given priorty
-        #                                           are processed (immediate, urgent, high, normal, low, languid)
+        # @option arguments [String] :wait_for_active_shards Wait until the specified number of shards is active
+        # @option arguments [String] :wait_for_nodes Wait until the specified number of nodes is available
+        # @option arguments [String] :wait_for_events Wait until all currently queued events with the given priority are processed (options: immediate, urgent, high, normal, low, languid)
+        # @option arguments [Boolean] :wait_for_no_relocating_shards Whether to wait until there are no relocating shards in the cluster
+        # @option arguments [Boolean] :wait_for_no_initializing_shards Whether to wait until there are no initializing shards in the cluster
+        # @option arguments [String] :wait_for_status Wait until cluster is in a specific state (options: green, yellow, red)
+        # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see http://elasticsearch.org/guide/reference/api/admin-cluster-health/
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-health.html
         #
-        def health(arguments={})
-          arguments = arguments.clone
-          index     = arguments.delete(:index)
-          method = HTTP_GET
-          path   = Utils.__pathify "_cluster/health", Utils.__listify(index)
+        def health(arguments = {})
+          headers = arguments.delete(:headers) || {}
 
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           body = nil
 
-          perform_request(method, path, params, body).body
-        end
+          arguments = arguments.clone
 
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.1.1
-        ParamsRegistry.register(:health, [
-            :expand_wildcards,
-            :level,
-            :local,
-            :master_timeout,
-            :timeout,
-            :wait_for_active_shards,
-            :wait_for_nodes,
-            :wait_for_events,
-            :wait_for_no_relocating_shards,
-            :wait_for_no_initializing_shards,
-            :wait_for_status ].freeze)
+          _index = arguments.delete(:index)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _index
+                     "_cluster/health/#{Utils.__listify(_index)}"
+                   else
+                     "_cluster/health"
+                   end
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
       end
     end
   end

data/lib/elasticsearch/api/actions/cluster/pending_tasks.rb

@@ -6,7 +6,7 @@
 # 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
+#   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
@@ -19,35 +19,30 @@ module Elasticsearch
   module API
     module Cluster
       module Actions
-
-        # Returns a list of any cluster-level changes (e.g. create index, update mapping, allocate or fail shard)
-        # which have not yet been executed and are queued up.
-        #
-        # @example Get a list of currently queued up tasks in the cluster
+        # Returns a list of any cluster-level changes (e.g. create index, update mapping,
+        # allocate or fail shard) which have not yet been executed.
         #
-        #     client.cluster.pending_tasks
-        #
-        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
-        #                                    (default: false)
+        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
         # @option arguments [Time] :master_timeout Specify timeout for connection to master
+        # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-pending.html
         #
-        def pending_tasks(arguments={})
-          method = HTTP_GET
+        def pending_tasks(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          method = Elasticsearch::API::HTTP_GET
           path   = "_cluster/pending_tasks"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
+          params = Utils.process_params(arguments)
 
-          perform_request(method, path, params, body).body
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.1.1
-        ParamsRegistry.register(:pending_tasks, [
-            :local,
-            :master_timeout ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/cluster/post_voting_config_exclusions.rb

@@ -0,0 +1,49 @@
+# 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
+        # Updates the cluster voting config exclusions by node ids or node names.
+        #
+        # @option arguments [String] :node_ids A comma-separated list of the persistent ids of the nodes to exclude from the voting configuration. If specified, you may not also specify ?node_names.
+        # @option arguments [String] :node_names A comma-separated list of the names of the nodes to exclude from the voting configuration. If specified, you may not also specify ?node_ids.
+        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/voting-config-exclusions.html
+        #
+        def post_voting_config_exclusions(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_cluster/voting_config_exclusions"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/cluster/put_component_template.rb

@@ -0,0 +1,56 @@
+# 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
+        # Creates or updates a component template
+        #
+        # @option arguments [String] :name The name of the template
+        # @option arguments [Boolean] :create Whether the index template should only be added if new or can also replace an existing one
+        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [Time] :master_timeout Specify timeout for connection to master
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The template definition (*Required*)
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html
+        #
+        def put_component_template(arguments = {})
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+          raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          arguments = arguments.clone
+
+          _name = arguments.delete(:name)
+
+          method = Elasticsearch::API::HTTP_PUT
+          path   = "_component_template/#{Utils.__listify(_name)}"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/cluster/put_settings.rb

@@ -6,7 +6,7 @@
 # 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
+#   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
@@ -19,34 +19,33 @@ module Elasticsearch
   module API
     module Cluster
       module Actions
-
-        # Update cluster settings.
-        #
-        # @example Disable shard allocation in the cluster until restart
-        #
-        #     client.cluster.put_settings body: { transient: { 'cluster.routing.allocation.disable_allocation' => true } }
+        # Updates the cluster settings.
         #
-        # @option arguments [Hash] :body The settings to be updated. Can be either `transient` or `persistent`
-        #                                (survives cluster restart).
+        # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
+        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The settings to be updated. Can be either `transient` or `persistent` (survives cluster restart). (*Required*)
         #
-        # @see http://elasticsearch.org/guide/reference/api/admin-cluster-update-settings/
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html
         #
-        def put_settings(arguments={})
-          method = HTTP_PUT
+        def put_settings(arguments = {})
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body) || {}
+
+          arguments = arguments.clone
+
+          method = Elasticsearch::API::HTTP_PUT
           path   = "_cluster/settings"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = arguments[:body] || {}
+          params = Utils.process_params(arguments)
 
-          perform_request(method, path, params, body).body
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.1.1
-        ParamsRegistry.register(:put_settings, [
-            :flat_settings,
-            :master_timeout,
-            :timeout ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/cluster/remote_info.rb

@@ -6,7 +6,7 @@
 # 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
+#   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
@@ -19,19 +19,26 @@ module Elasticsearch
   module API
     module Cluster
       module Actions
-
-        # Returns the configured remote cluster information
+        # Returns the information about configured remote clusters.
         #
+        # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-remote-info.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-remote-info.html
         #
-        def remote_info(arguments={})
+        def remote_info(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
           method = Elasticsearch::API::HTTP_GET
           path   = "_remote/info"
           params = {}
-          body   = nil
 
-          perform_request(method, path, params, body).body
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
         end
       end
     end

data/lib/elasticsearch/api/actions/cluster/reroute.rb

@@ -6,7 +6,7 @@
 # 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
+#   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
@@ -19,55 +19,34 @@ module Elasticsearch
   module API
     module Cluster
       module Actions
-
-        # Perform manual shard allocation in the cluster.
-        #
-        # Pass the operations you want to perform in the `:body` option. Use the `dry_run` option to
-        # evaluate the result of operations without actually performing them.
-        #
-        # @example Move shard `0` of index `myindex` from node named _Node1_ to node named _Node2_
-        #
-        #     client.cluster.reroute body: {
-        #       commands: [
-        #         { move: { index: 'myindex', shard: 0, from_node: 'Node1', to_node: 'Node2' } }
-        #       ]
-        #     }
+        # Allows to manually change the allocation of individual shards in the cluster.
         #
-        # @note If you want to explicitly set the shard allocation to a certain node, you might
-        #       want to look at the `allocation.*` cluster settings.
-        #
-        # @option arguments [Hash] :body The definition of `commands` to perform (`move`, `cancel`, `allocate`)
         # @option arguments [Boolean] :dry_run Simulate the operation only and return the resulting state
-        # @option arguments [Boolean] :explain Return an explanation for why the commands can or cannot be executed
-        # @option arguments [Boolean] :metric Limit the information returned to the specified metrics.
-        #                                     Defaults to all but metadata. (Options: _all, blocks, metadata,
-        #                                     nodes, routing_table, master_node, version)
-        # @option arguments [Time] :master_timeout Specify timeout for connection to master
-        # @option arguments [Boolean] :retry_failed Retries allocation of shards that are blocked due to too many
-        #                                           subsequent allocation failures
+        # @option arguments [Boolean] :explain Return an explanation of why the commands can or cannot be executed
+        # @option arguments [Boolean] :retry_failed Retries allocation of shards that are blocked due to too many subsequent allocation failures
+        # @option arguments [List] :metric Limit the information returned to the specified metrics. Defaults to all but metadata (options: _all, blocks, metadata, nodes, routing_table, master_node, version)
+        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The definition of `commands` to perform (`move`, `cancel`, `allocate`)
         #
-        # @see http://elasticsearch.org/guide/reference/api/admin-cluster-reroute/
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-reroute.html
         #
-        def reroute(arguments={})
-          method = HTTP_POST
-          path   = "_cluster/reroute"
+        def reroute(arguments = {})
+          headers = arguments.delete(:headers) || {}
 
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = arguments[:body] || {}
+          body = arguments.delete(:body) || {}
 
-          perform_request(method, path, params, body).body
-        end
+          arguments = arguments.clone
 
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.1.1
-        ParamsRegistry.register(:reroute, [
-            :dry_run,
-            :explain,
-            :retry_failed,
-            :metric,
-            :master_timeout,
-            :timeout ].freeze)
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_cluster/reroute"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
       end
     end
   end