lib/elasticsearch/api/actions/bulk.rb in elasticsearch-api-6.8.3 vs lib/elasticsearch/api/actions/bulk.rb in elasticsearch-api-7.0.0.pre
- old
+ new
@@ -1,8 +1,21 @@
-# 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 Actions
@@ -51,17 +64,16 @@
#
# ]
#
# @option arguments [String] :index Default index for items which don't provide one
# @option arguments [String] :type Default document type for items which don't provide one
- # @option arguments [Hash] :body The operation definition and data (action-data pairs), separated by newlines (*Required*) Note that this cannot be empty.
+ # @option arguments [Hash] :body The operation definition and data (action-data pairs), separated by newlines (*Required*)
# @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the bulk operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
# @option arguments [String] :refresh If `true` then refresh the effected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (options: true, false, wait_for)
# @option arguments [String] :routing Specific routing value
# @option arguments [Time] :timeout Explicit operation timeout
# @option arguments [String] :type Default document type for items which don't provide one
- # @option arguments [List] :fields Default comma-separated list of fields to return in the response for updates, can be overridden on each sub-request
# @option arguments [List] :_source True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request
# @option arguments [List] :_source_excludes Default list of fields to exclude from the returned _source field, can be overridden on each sub-request
# @option arguments [List] :_source_includes Default list of fields to extract and return from the _source field, can be overridden on each sub-request
# @option arguments [String] :pipeline The pipeline id to preprocess incoming documents with
#
@@ -89,17 +101,16 @@
perform_request(method, path, params, payload, {"Content-Type" => "application/x-ndjson"}).body
end
# Register this action with its valid params when the module is loaded.
#
- # @since 6.2.0
+ # @since 6.1.1
ParamsRegistry.register(:bulk, [
:wait_for_active_shards,
:refresh,
:routing,
:timeout,
:type,
- :fields,
:_source,
:_source_excludes,
:_source_includes,
:pipeline ].freeze)
end