File OpenSearch/Endpoints/MsearchTemplate.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\Serializers\SerializerInterface;
25:
26:	/**
27:	* NOTE: This file is autogenerated using util/GenerateEndpoints.php
28:	*/
29:	class MsearchTemplate extends AbstractEndpoint
30:	{
31:	public function __construct(SerializerInterface $serializer)
32:	{
33:	$this->serializer = $serializer;
34:	}
35:
36:	public function getURI(): string
37:	{
38:	$index = $this->index ?? null;
39:	if (isset($index)) {
40:	return "/$index/_msearch/template";
41:	}
42:	return "/_msearch/template";
43:	}
44:
45:	public function getParamWhitelist(): array
46:	{
47:	return [
48:	'ccs_minimize_roundtrips',
49:	'max_concurrent_searches',
50:	'rest_total_hits_as_int',
51:	'search_type',
52:	'typed_keys',
53:	'pretty',
54:	'human',
55:	'error_trace',
56:	'source',
57:	'filter_path'
58:	];
59:	}
60:
61:	public function getMethod(): string
62:	{
63:	return isset($this->body) ? 'POST' : 'GET';
64:	}
65:
66:	public function setBody(string\|iterable\|null $body): static
67:	{
68:	if (is_null($body)) {
69:	return $this;
70:	}
71:
72:	if (is_string($body)) {
73:	if (!str_ends_with($body, "\n")) {
74:	$body .= "\n";
75:	}
76:	$this->body = $body;
77:	return $this;
78:	}
79:
80:	// Must be an iterable.
81:	foreach ($body as $item) {
82:	$this->body .= $this->serializer->serialize($item) . "\n";
83:	}
84:
85:	return $this;
86:	}
87:
88:	}
89:

Namespaces

Classes