File OpenSearch/Endpoints/Indices/GetFieldMapping.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\Indices;
23:
24:	use OpenSearch\Exception\RuntimeException;
25:	use OpenSearch\Endpoints\AbstractEndpoint;
26:
27:	/**
28:	* NOTE: This file is autogenerated using util/GenerateEndpoints.php
29:	*/
30:	class GetFieldMapping extends AbstractEndpoint
31:	{
32:	protected $fields;
33:
34:	public function getURI(): string
35:	{
36:	if (!isset($this->fields) \|\| $this->fields === '') {
37:	throw new RuntimeException('fields is required for get_field_mapping');
38:	}
39:	$fields = $this->fields;
40:	$index = $this->index ?? null;
41:	if (isset($index)) {
42:	return "/$index/_mapping/field/$fields";
43:	}
44:	return "/_mapping/field/$fields";
45:	}
46:
47:	public function getParamWhitelist(): array
48:	{
49:	return [
50:	'allow_no_indices',
51:	'expand_wildcards',
52:	'ignore_unavailable',
53:	'include_defaults',
54:	'local',
55:	'pretty',
56:	'human',
57:	'error_trace',
58:	'source',
59:	'filter_path'
60:	];
61:	}
62:
63:	public function getMethod(): string
64:	{
65:	return 'GET';
66:	}
67:
68:	public function setFields($fields): static
69:	{
70:	if (isset($fields) !== true) {
71:	return $this;
72:	}
73:	if (is_array($fields) === true) {
74:	$fields = implode(",", $fields);
75:	}
76:	$this->fields = $fields;
77:
78:	return $this;
79:	}
80:	}
81:

Namespaces

Classes