lib/elasticsearch/api/actions/cluster/allocation_explain.rb in elasticsearch-api-6.8.3 vs lib/elasticsearch/api/actions/cluster/allocation_explain.rb in elasticsearch-api-7.0.0.pre
- old
+ new
@@ -1,21 +1,35 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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
# Return the information about why a shard is or isn't allocated
#
# @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)
#
- # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-allocation-explain.html
+ # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-allocation-explain.html
#
def allocation_explain(arguments={})
method = 'GET'
path = "_cluster/allocation/explain"
params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
@@ -24,10 +38,10 @@
perform_request(method, path, params, body).body
end
# Register this action with its valid params when the module is loaded.
#
- # @since 6.2.0
+ # @since 6.1.1
ParamsRegistry.register(:allocation_explain, [
:include_yes_decisions,
:include_disk_info ].freeze)
end
end