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\Endpoints\AbstractEndpoint; |
25: | |
26: | /** |
27: | * NOTE: This file is autogenerated using util/GenerateEndpoints.php |
28: | */ |
29: | class Cancel extends AbstractEndpoint |
30: | { |
31: | protected $task_id; |
32: | |
33: | public function getURI(): string |
34: | { |
35: | $task_id = $this->task_id ?? null; |
36: | if (isset($task_id)) { |
37: | return "/_tasks/$task_id/_cancel"; |
38: | } |
39: | return "/_tasks/_cancel"; |
40: | } |
41: | |
42: | public function getParamWhitelist(): array |
43: | { |
44: | return [ |
45: | 'actions', |
46: | 'nodes', |
47: | 'parent_task_id', |
48: | 'wait_for_completion', |
49: | 'pretty', |
50: | 'human', |
51: | 'error_trace', |
52: | 'source', |
53: | 'filter_path' |
54: | ]; |
55: | } |
56: | |
57: | public function getMethod(): string |
58: | { |
59: | return 'POST'; |
60: | } |
61: | |
62: | public function setTaskId($task_id): static |
63: | { |
64: | if (isset($task_id) !== true) { |
65: | return $this; |
66: | } |
67: | $this->task_id = $task_id; |
68: | |
69: | return $this; |
70: | } |
71: | } |
72: |