File OpenSearch/Endpoints/Explain.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\RuntimeException;
25:	use OpenSearch\Endpoints\AbstractEndpoint;
26:
27:	/**
28:	* NOTE: This file is autogenerated using util/GenerateEndpoints.php
29:	*/
30:	class Explain extends AbstractEndpoint
31:	{
32:	public function getURI(): string
33:	{
34:	if (isset($this->id) !== true) {
35:	throw new RuntimeException(
36:	'id is required for explain'
37:	);
38:	}
39:	$id = $this->id;
40:	if (isset($this->index) !== true) {
41:	throw new RuntimeException(
42:	'index is required for explain'
43:	);
44:	}
45:	$index = $this->index;
46:	return "/$index/_explain/$id";
47:	}
48:
49:	public function getParamWhitelist(): array
50:	{
51:	return [
52:	'_source',
53:	'_source_excludes',
54:	'_source_includes',
55:	'analyze_wildcard',
56:	'analyzer',
57:	'default_operator',
58:	'df',
59:	'lenient',
60:	'preference',
61:	'q',
62:	'routing',
63:	'stored_fields',
64:	'pretty',
65:	'human',
66:	'error_trace',
67:	'source',
68:	'filter_path'
69:	];
70:	}
71:
72:	public function getMethod(): string
73:	{
74:	return isset($this->body) ? 'POST' : 'GET';
75:	}
76:
77:	public function setBody($body): static
78:	{
79:	if (isset($body) !== true) {
80:	return $this;
81:	}
82:	$this->body = $body;
83:
84:	return $this;
85:	}
86:	}
87:

Namespaces

Classes