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\Ml;
18
19use Elasticsearch\Common\Exceptions\RuntimeException;
20use Elasticsearch\Endpoints\AbstractEndpoint;
21
22/**
23 * Class GetCategories
24 * Elasticsearch API name ml.get_categories
25 *
26 * NOTE: this file is autogenerated using util/GenerateEndpoints.php
27 * and Elasticsearch 7.16.0-SNAPSHOT (dfc9a8e7563ed5f24b5210ed21ed92ae182cd0ee)
28 */
29class GetCategories extends AbstractEndpoint
30{
31    protected $job_id;
32    protected $category_id;
33
34    public function getURI(): string
35    {
36        if (isset($this->job_id) !== true) {
37            throw new RuntimeException(
38                'job_id is required for get_categories'
39            );
40        }
41        $job_id = $this->job_id;
42        $category_id = $this->category_id ?? null;
43
44        if (isset($category_id)) {
45            return "/_ml/anomaly_detectors/$job_id/results/categories/$category_id";
46        }
47        return "/_ml/anomaly_detectors/$job_id/results/categories/";
48    }
49
50    public function getParamWhitelist(): array
51    {
52        return [
53            'from',
54            'size',
55            'partition_field_value'
56        ];
57    }
58
59    public function getMethod(): string
60    {
61        return isset($this->body) ? 'POST' : 'GET';
62    }
63
64    public function setBody($body): GetCategories
65    {
66        if (isset($body) !== true) {
67            return $this;
68        }
69        $this->body = $body;
70
71        return $this;
72    }
73
74    public function setJobId($job_id): GetCategories
75    {
76        if (isset($job_id) !== true) {
77            return $this;
78        }
79        $this->job_id = $job_id;
80
81        return $this;
82    }
83
84    public function setCategoryId($category_id): GetCategories
85    {
86        if (isset($category_id) !== true) {
87            return $this;
88        }
89        $this->category_id = $category_id;
90
91        return $this;
92    }
93}
94