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\Common\Exceptions\InvalidArgumentException;
25:	use OpenSearch\Endpoints\AbstractEndpoint;
26:	use OpenSearch\Serializers\SerializerInterface;
27:	use Traversable;
28:
29:	/**
30:	* NOTE: This file is autogenerated using util/GenerateEndpoints.php
31:	*/
32:	class MsearchTemplate extends AbstractEndpoint
33:	{
34:	public function __construct(SerializerInterface $serializer)
35:	{
36:	$this->serializer = $serializer;
37:	}
38:
39:	public function getURI(): string
40:	{
41:	$index = $this->index ?? null;
42:	if (isset($index)) {
43:	return "/$index/_msearch/template";
44:	}
45:	return "/_msearch/template";
46:	}
47:
48:	public function getParamWhitelist(): array
49:	{
50:	return [
51:	'ccs_minimize_roundtrips',
52:	'max_concurrent_searches',
53:	'rest_total_hits_as_int',
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:	if (is_array($body) === true \|\| $body instanceof Traversable) {
75:	foreach ($body as $item) {
76:	$this->body .= $this->serializer->serialize($item) . "\n";
77:	}
78:	} elseif (is_string($body)) {
79:	$this->body = $body;
80:	if (substr($body, -1) != "\n") {
81:	$this->body .= "\n";
82:	}
83:	} else {
84:	throw new InvalidArgumentException("Body must be an array, traversable object or string");
85:	}
86:	return $this;
87:	}
88:
89:	}
90:

Namespaces

Classes