File OpenSearch/Endpoints/DataFrameTransformDeprecated/StopTransform.php

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\DataFrameTransformDeprecated;
23:
24:	use OpenSearch\Common\Exceptions\RuntimeException;
25:	use OpenSearch\Endpoints\AbstractEndpoint;
26:
27:	class StopTransform extends AbstractEndpoint
28:	{
29:	protected $transform_id;
30:
31:	public function getURI(): string
32:	{
33:	$transform_id = $this->transform_id ?? null;
34:
35:	if (isset($transform_id)) {
36:	return "/_data_frame/transforms/$transform_id/_stop";
37:	}
38:	throw new RuntimeException('Missing parameter for the endpoint data_frame_transform_deprecated.stop_transform');
39:	}
40:
41:	public function getParamWhitelist(): array
42:	{
43:	return [
44:	'wait_for_completion',
45:	'timeout',
46:	'allow_no_match'
47:	];
48:	}
49:
50:	public function getMethod(): string
51:	{
52:	return 'POST';
53:	}
54:
55:	public function setTransformId($transform_id): StopTransform
56:	{
57:	if (isset($transform_id) !== true) {
58:	return $this;
59:	}
60:	$this->transform_id = $transform_id;
61:
62:	return $this;
63:	}
64:	}
65:

Namespaces

Classes