File OpenSearch/Endpoints/Scroll.php

1:	<?php
2:
3:	declare(strict_types=1);
4:
5:	/**
6:	* Copyright OpenSearch Contributors
7:	* SPDX-License-Identifier: Apache-2.0
8:	*
9:	* OpenSearch PHP client
10:	*
11:	* @link https://github.com/opensearch-project/opensearch-php/
12:	* @copyright Copyright (c) Elasticsearch B.V (https://www.elastic.co)
13:	* @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
14:	* @license https://www.gnu.org/licenses/lgpl-2.1.html GNU Lesser General Public License, Version 2.1
15:	*
16:	* Licensed to Elasticsearch B.V under one or more agreements.
17:	* Elasticsearch B.V licenses this file to you under the Apache 2.0 License or
18:	* the GNU Lesser General Public License, Version 2.1, at your option.
19:	* See the LICENSE file in the project root for more information.
20:	*/
21:
22:	namespace OpenSearch\Endpoints;
23:
24:	/**
25:	* NOTE: This file is autogenerated using util/GenerateEndpoints.php
26:	*/
27:	class Scroll extends AbstractEndpoint
28:	{
29:	protected $scroll_id;
30:
31:	public function getURI(): string
32:	{
33:	$scroll_id = $this->scroll_id ?? null;
34:	if (isset($scroll_id)) {
35:	@trigger_error('A scroll id can be quite large and should be specified as part of the body', E_USER_DEPRECATED);
36:	}
37:
38:	if (isset($scroll_id)) {
39:	return "/_search/scroll/$scroll_id";
40:	}
41:	return "/_search/scroll";
42:	}
43:
44:	public function getParamWhitelist(): array
45:	{
46:	return [
47:	'rest_total_hits_as_int',
48:	'scroll',
49:	'scroll_id',
50:	'pretty',
51:	'human',
52:	'error_trace',
53:	'source',
54:	'filter_path'
55:	];
56:	}
57:
58:	public function getMethod(): string
59:	{
60:	return isset($this->body) ? 'POST' : 'GET';
61:	}
62:
63:	public function setBody($body): static
64:	{
65:	if (is_null($body)) {
66:	return $this;
67:	}
68:	$this->body = $body;
69:
70:	return $this;
71:	}
72:
73:	public function setScrollId($scroll_id): static
74:	{
75:	if (is_null($scroll_id)) {
76:	return $this;
77:	}
78:	$this->scroll_id = $scroll_id;
79:
80:	return $this;
81:	}
82:	}
83:

Namespaces

Classes