1<?php 2/** 3 * Elasticsearch PHP client 4 * 5 * @link https://github.com/elastic/elasticsearch-php/ 6 * @copyright Copyright (c) Elasticsearch B.V (https://www.elastic.co) 7 * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0 8 * @license https://www.gnu.org/licenses/lgpl-2.1.html GNU Lesser General Public License, Version 2.1 9 * 10 * Licensed to Elasticsearch B.V under one or more agreements. 11 * Elasticsearch B.V licenses this file to you under the Apache 2.0 License or 12 * the GNU Lesser General Public License, Version 2.1, at your option. 13 * See the LICENSE file in the project root for more information. 14 */ 15declare(strict_types = 1); 16 17namespace Elasticsearch\Endpoints; 18 19use Elasticsearch\Common\Exceptions\RuntimeException; 20use Elasticsearch\Endpoints\AbstractEndpoint; 21 22/** 23 * Class DeleteByQuery 24 * Elasticsearch API name delete_by_query 25 * 26 * NOTE: this file is autogenerated using util/GenerateEndpoints.php 27 * and Elasticsearch 7.16.0-SNAPSHOT (dfc9a8e7563ed5f24b5210ed21ed92ae182cd0ee) 28 */ 29class DeleteByQuery extends AbstractEndpoint 30{ 31 32 public function getURI(): string 33 { 34 if (isset($this->index) !== true) { 35 throw new RuntimeException( 36 'index is required for delete_by_query' 37 ); 38 } 39 $index = $this->index; 40 $type = $this->type ?? null; 41 if (isset($type)) { 42 @trigger_error('Specifying types in urls has been deprecated', E_USER_DEPRECATED); 43 } 44 45 if (isset($type)) { 46 return "/$index/$type/_delete_by_query"; 47 } 48 return "/$index/_delete_by_query"; 49 } 50 51 public function getParamWhitelist(): array 52 { 53 return [ 54 'analyzer', 55 'analyze_wildcard', 56 'default_operator', 57 'df', 58 'from', 59 'ignore_unavailable', 60 'allow_no_indices', 61 'conflicts', 62 'expand_wildcards', 63 'lenient', 64 'preference', 65 'q', 66 'routing', 67 'scroll', 68 'search_type', 69 'search_timeout', 70 'size', 71 'max_docs', 72 'sort', 73 '_source', 74 '_source_excludes', 75 '_source_includes', 76 'terminate_after', 77 'stats', 78 'version', 79 'request_cache', 80 'refresh', 81 'timeout', 82 'wait_for_active_shards', 83 'scroll_size', 84 'wait_for_completion', 85 'requests_per_second', 86 'slices' 87 ]; 88 } 89 90 public function getMethod(): string 91 { 92 return 'POST'; 93 } 94 95 public function setBody($body): DeleteByQuery 96 { 97 if (isset($body) !== true) { 98 return $this; 99 } 100 $this->body = $body; 101 102 return $this; 103 } 104} 105