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

Namespaces

Classes