1<?php
2/**
3 * Elasticsearch PHP client
4 *
5 * @link      https://github.com/elastic/elasticsearch-php/
6 * @copyright Copyright (c) Elasticsearch B.V (https://www.elastic.co)
7 * @license   http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
8 * @license   https://www.gnu.org/licenses/lgpl-2.1.html GNU Lesser General Public License, Version 2.1
9 *
10 * Licensed to Elasticsearch B.V under one or more agreements.
11 * Elasticsearch B.V licenses this file to you under the Apache 2.0 License or
12 * the GNU Lesser General Public License, Version 2.1, at your option.
13 * See the LICENSE file in the project root for more information.
14 */
15declare(strict_types = 1);
16
17namespace Elasticsearch\Endpoints\Indices;
18
19use Elasticsearch\Common\Exceptions\RuntimeException;
20use Elasticsearch\Endpoints\AbstractEndpoint;
21
22/**
23 * Class GetFieldMapping
24 * Elasticsearch API name indices.get_field_mapping
25 *
26 * NOTE: this file is autogenerated using util/GenerateEndpoints.php
27 * and Elasticsearch 7.16.0-SNAPSHOT (dfc9a8e7563ed5f24b5210ed21ed92ae182cd0ee)
28 */
29class GetFieldMapping extends AbstractEndpoint
30{
31    protected $fields;
32
33    public function getURI(): string
34    {
35        if (isset($this->fields) !== true) {
36            throw new RuntimeException(
37                'fields is required for get_field_mapping'
38            );
39        }
40        $fields = $this->fields;
41        $index = $this->index ?? null;
42        $type = $this->type ?? null;
43        if (isset($type)) {
44            @trigger_error('Specifying types in urls has been deprecated', E_USER_DEPRECATED);
45        }
46
47        if (isset($index) && isset($type)) {
48            return "/$index/_mapping/$type/field/$fields";
49        }
50        if (isset($index)) {
51            return "/$index/_mapping/field/$fields";
52        }
53        if (isset($type)) {
54            return "/_mapping/$type/field/$fields";
55        }
56        return "/_mapping/field/$fields";
57    }
58
59    public function getParamWhitelist(): array
60    {
61        return [
62            'include_type_name',
63            'include_defaults',
64            'ignore_unavailable',
65            'allow_no_indices',
66            'expand_wildcards',
67            'local'
68        ];
69    }
70
71    public function getMethod(): string
72    {
73        return 'GET';
74    }
75
76    public function setFields($fields): GetFieldMapping
77    {
78        if (isset($fields) !== true) {
79            return $this;
80        }
81        if (is_array($fields) === true) {
82            $fields = implode(",", $fields);
83        }
84        $this->fields = $fields;
85
86        return $this;
87    }
88}
89