lib/elasticsearch/api/actions/delete.rb in elasticsearch-api-6.8.3 vs lib/elasticsearch/api/actions/delete.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 @@ -16,35 +29,27 @@ # # client.delete index: 'myindex', type: 'mytype', id: '1', routing: 'abc123' # # @option arguments [String] :id The document ID (*Required*) # @option arguments [String] :index The name of the index (*Required*) - # @option arguments [String] :type The type of the document (*Required*) - # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before - # proceeding with the delete 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] :type The type of the document + # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the delete 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] :parent ID of parent document - # @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] :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 [Number] :if_seq_no only perform the delete operation if the last operation that has changed - # the document has the specified sequence number - # @option arguments [Number] :if_primary_term only perform the delete operation if the last operation that has - # changed the document has the specified primary term + # @option arguments [Number] :if_seq_no only perform the delete operation if the last operation that has changed the document has the specified sequence number + # @option arguments [Number] :if_primary_term only perform the delete operation if the last operation that has changed the document has the specified primary term # @option arguments [Number] :version Explicit version number for concurrency control - # @option arguments [String] :version_type Specific version type - # (options: internal, external, external_gte, force) + # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte, force) # # @see http://elasticsearch.org/guide/reference/api/delete/ # def delete(arguments={}) raise ArgumentError, "Required argument 'index' missing" unless arguments[:index] - raise ArgumentError, "Required argument 'type' missing" unless arguments[:type] raise ArgumentError, "Required argument 'id' missing" unless arguments[:id] + arguments[:type] ||= DEFAULT_DOC method = HTTP_DELETE path = Utils.__pathify Utils.__escape(arguments[:index]), Utils.__escape(arguments[:type]), Utils.__escape(arguments[:id]) @@ -59,10 +64,10 @@ end end # Register this action with its valid params when the module is loaded. # - # @since 6.2.0 + # @since 6.1.1 ParamsRegistry.register(:delete, [ :wait_for_active_shards, :parent, :refresh, :routing,