File OpenSearch/Endpoints/SearchTemplate.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 SearchTemplate extends AbstractEndpoint
30:	{
31:	public function getURI(): string
32:	{
33:	$index = $this->index ?? null;
34:	if (isset($index)) {
35:	return "/$index/_search/template";
36:	}
37:	return "/_search/template";
38:	}
39:
40:	public function getParamWhitelist(): array
41:	{
42:	return [
43:	'allow_no_indices',
44:	'ccs_minimize_roundtrips',
45:	'expand_wildcards',
46:	'explain',
47:	'ignore_throttled',
48:	'ignore_unavailable',
49:	'preference',
50:	'profile',
51:	'rest_total_hits_as_int',
52:	'routing',
53:	'scroll',
54:	'search_type',
55:	'typed_keys',
56:	'pretty',
57:	'human',
58:	'error_trace',
59:	'source',
60:	'filter_path'
61:	];
62:	}
63:
64:	public function getMethod(): string
65:	{
66:	return isset($this->body) ? 'POST' : 'GET';
67:	}
68:
69:	public function setBody($body): static
70:	{
71:	if (isset($body) !== true) {
72:	return $this;
73:	}
74:	$this->body = $body;
75:
76:	return $this;
77:	}
78:	}
79:

Namespaces

Classes