File OpenSearch/Endpoints/DeleteByQuery.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;
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 DeleteByQuery extends AbstractEndpoint
31:	{
32:	public function getURI(): string
33:	{
34:	if (isset($this->index) !== true) {
35:	throw new RuntimeException(
36:	'index is required for delete_by_query'
37:	);
38:	}
39:	$index = $this->index;
40:	return "/$index/_delete_by_query";
41:	}
42:
43:	public function getParamWhitelist(): array
44:	{
45:	return [
46:	'_source',
47:	'_source_excludes',
48:	'_source_includes',
49:	'allow_no_indices',
50:	'analyze_wildcard',
51:	'analyzer',
52:	'conflicts',
53:	'default_operator',
54:	'df',
55:	'expand_wildcards',
56:	'from',
57:	'ignore_unavailable',
58:	'lenient',
59:	'max_docs',
60:	'preference',
61:	'q',
62:	'refresh',
63:	'request_cache',
64:	'requests_per_second',
65:	'routing',
66:	'scroll',
67:	'scroll_size',
68:	'search_timeout',
69:	'search_type',
70:	'size',
71:	'slices',
72:	'sort',
73:	'stats',
74:	'terminate_after',
75:	'timeout',
76:	'version',
77:	'wait_for_active_shards',
78:	'wait_for_completion',
79:	'pretty',
80:	'human',
81:	'error_trace',
82:	'source',
83:	'filter_path'
84:	];
85:	}
86:
87:	public function getMethod(): string
88:	{
89:	return 'POST';
90:	}
91:
92:	public function setBody($body): static
93:	{
94:	if (isset($body) !== true) {
95:	return $this;
96:	}
97:	$this->body = $body;
98:
99:	return $this;
100:	}
101:	}
102:

Namespaces

Classes