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\Endpoints\AbstractEndpoint;
20
21/**
22 * Class Scroll
23 * Elasticsearch API name scroll
24 *
25 * NOTE: this file is autogenerated using util/GenerateEndpoints.php
26 * and Elasticsearch 7.16.0-SNAPSHOT (dfc9a8e7563ed5f24b5210ed21ed92ae182cd0ee)
27 */
28class Scroll extends AbstractEndpoint
29{
30    protected $scroll_id;
31
32    public function getURI(): string
33    {
34        $scroll_id = $this->scroll_id ?? null;
35        if (isset($scroll_id)) {
36            @trigger_error('A scroll id can be quite large and should be specified as part of the body', E_USER_DEPRECATED);
37        }
38
39        if (isset($scroll_id)) {
40            return "/_search/scroll/$scroll_id";
41        }
42        return "/_search/scroll";
43    }
44
45    public function getParamWhitelist(): array
46    {
47        return [
48            'scroll',
49            'scroll_id',
50            'rest_total_hits_as_int'
51        ];
52    }
53
54    public function getMethod(): string
55    {
56        return isset($this->body) ? 'POST' : 'GET';
57    }
58
59    public function setBody($body): Scroll
60    {
61        if (isset($body) !== true) {
62            return $this;
63        }
64        $this->body = $body;
65
66        return $this;
67    }
68
69    public function setScrollId($scroll_id): Scroll
70    {
71        if (isset($scroll_id) !== true) {
72            return $this;
73        }
74        $this->scroll_id = $scroll_id;
75
76        return $this;
77    }
78}
79