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\Tasks;
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 Get extends AbstractEndpoint
31: {
32: protected $task_id;
33:
34: public function getURI(): string
35: {
36: $task_id = $this->task_id ?? null;
37: if (isset($task_id)) {
38: return "/_tasks/$task_id";
39: }
40: throw new RuntimeException('Missing parameter for the endpoint tasks.get');
41: }
42:
43: public function getParamWhitelist(): array
44: {
45: return [
46: 'timeout',
47: 'wait_for_completion',
48: 'pretty',
49: 'human',
50: 'error_trace',
51: 'source',
52: 'filter_path'
53: ];
54: }
55:
56: public function getMethod(): string
57: {
58: return 'GET';
59: }
60:
61: public function setTaskId($task_id): static
62: {
63: if (isset($task_id) !== true) {
64: return $this;
65: }
66: $this->task_id = $task_id;
67:
68: return $this;
69: }
70: }
71: