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 UpdateByQuery
24 * Elasticsearch API name update_by_query
25 *
26 * NOTE: this file is autogenerated using util/GenerateEndpoints.php
27 * and Elasticsearch 7.16.0-SNAPSHOT (dfc9a8e7563ed5f24b5210ed21ed92ae182cd0ee)
28 */
29class UpdateByQuery 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 update_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/_update_by_query";
47        }
48        return "/$index/_update_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            'pipeline',
65            'preference',
66            'q',
67            'routing',
68            'scroll',
69            'search_type',
70            'search_timeout',
71            'size',
72            'max_docs',
73            'sort',
74            '_source',
75            '_source_excludes',
76            '_source_includes',
77            'terminate_after',
78            'stats',
79            'version',
80            'version_type',
81            'request_cache',
82            'refresh',
83            'timeout',
84            'wait_for_active_shards',
85            'scroll_size',
86            'wait_for_completion',
87            'requests_per_second',
88            'slices'
89        ];
90    }
91
92    public function getMethod(): string
93    {
94        return 'POST';
95    }
96
97    public function setBody($body): UpdateByQuery
98    {
99        if (isset($body) !== true) {
100            return $this;
101        }
102        $this->body = $body;
103
104        return $this;
105    }
106}
107