lib/elasticsearch/api/actions/indices/split.rb in elasticsearch-api-6.8.3 vs lib/elasticsearch/api/actions/indices/split.rb in elasticsearch-api-7.0.0.pre
- old
+ new
@@ -1,26 +1,37 @@
-# 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 Indices
module Actions
- # The split index API allows you to split an existing index into a new index,
- # where each original primary shard is split into two or more primary shards in the new index.
+ # The split index API allows you to split an existing index into a new index with multiple of its primary shards.
#
# @option arguments [String] :index The name of the source index to split (*Required*)
# @option arguments [String] :target The name of the target index to split into (*Required*)
# @option arguments [Hash] :body The configuration for the target index (`settings` and `aliases`)
- # @option arguments [Boolean] :copy_settings whether or not to copy settings from the source index (defaults to false)
# @option arguments [Time] :timeout Explicit operation timeout
# @option arguments [Time] :master_timeout Specify timeout for connection to master
# @option arguments [String] :wait_for_active_shards Set the number of active shards to wait for on the shrunken index before the operation returns.
#
- # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-split-index.html
+ # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-split-index.html
#
def split(arguments={})
raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
raise ArgumentError, "Required argument 'target' missing" unless arguments[:target]
arguments = arguments.clone
@@ -35,12 +46,11 @@
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(:split, [
- :copy_settings,
:timeout,
:master_timeout,
:wait_for_active_shards ].freeze)
end
end