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 GetBuckets
24 * Elasticsearch API name ml.get_buckets
25 *
26 * NOTE: this file is autogenerated using util/GenerateEndpoints.php
27 * and Elasticsearch 7.16.0-SNAPSHOT (dfc9a8e7563ed5f24b5210ed21ed92ae182cd0ee)
28 */
29class GetBuckets extends AbstractEndpoint
30{
31    protected $job_id;
32    protected $timestamp;
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_buckets'
39            );
40        }
41        $job_id = $this->job_id;
42        $timestamp = $this->timestamp ?? null;
43
44        if (isset($timestamp)) {
45            return "/_ml/anomaly_detectors/$job_id/results/buckets/$timestamp";
46        }
47        return "/_ml/anomaly_detectors/$job_id/results/buckets";
48    }
49
50    public function getParamWhitelist(): array
51    {
52        return [
53            'expand',
54            'exclude_interim',
55            'from',
56            'size',
57            'start',
58            'end',
59            'anomaly_score',
60            'sort',
61            'desc'
62        ];
63    }
64
65    public function getMethod(): string
66    {
67        return isset($this->body) ? 'POST' : 'GET';
68    }
69
70    public function setBody($body): GetBuckets
71    {
72        if (isset($body) !== true) {
73            return $this;
74        }
75        $this->body = $body;
76
77        return $this;
78    }
79
80    public function setJobId($job_id): GetBuckets
81    {
82        if (isset($job_id) !== true) {
83            return $this;
84        }
85        $this->job_id = $job_id;
86
87        return $this;
88    }
89
90    public function setTimestamp($timestamp): GetBuckets
91    {
92        if (isset($timestamp) !== true) {
93            return $this;
94        }
95        $this->timestamp = $timestamp;
96
97        return $this;
98    }
99}
100