lib/elasticsearch/api/actions/cluster/allocation_explain.rb in elasticsearch-api-7.4.0 vs lib/elasticsearch/api/actions/cluster/allocation_explain.rb in elasticsearch-api-7.5.0.pre.pre

- old
+ new

@@ -4,34 +4,36 @@ module Elasticsearch module API module Cluster module Actions - - # Return the information about why a shard is or isn't allocated + # Provides explanations for shard allocations in the cluster. # - # @option arguments [Hash] :body The index, shard, and primary flag to explain. Empty means 'explain the first unassigned shard' # @option arguments [Boolean] :include_yes_decisions Return 'YES' decisions in explanation (default: false) - # @option arguments [Boolean] :include_disk_info Return information about disk usage and shard sizes - # (default: false) + # @option arguments [Boolean] :include_disk_info Return information about disk usage and shard sizes (default: false) + + # @option arguments [Hash] :body The index, shard, and primary flag to explain. Empty means 'explain the first unassigned shard' # - # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-allocation-explain.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/cluster-allocation-explain.html # - def allocation_explain(arguments={}) - method = 'GET' + def allocation_explain(arguments = {}) + arguments = arguments.clone + + method = Elasticsearch::API::HTTP_GET path = "_cluster/allocation/explain" params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__) - body = arguments[:body] + 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 + # @since 6.2.0 ParamsRegistry.register(:allocation_explain, [ - :include_yes_decisions, - :include_disk_info ].freeze) + :include_yes_decisions, + :include_disk_info + ].freeze) +end end - end end end