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\Namespaces; 18 19use Elasticsearch\Namespaces\AbstractNamespace; 20 21/** 22 * Class EnrichNamespace 23 * 24 * NOTE: this file is autogenerated using util/GenerateEndpoints.php 25 * and Elasticsearch 7.16.0-SNAPSHOT (dfc9a8e7563ed5f24b5210ed21ed92ae182cd0ee) 26 */ 27class EnrichNamespace extends AbstractNamespace 28{ 29 30 /** 31 * Deletes an existing enrich policy and its enrich index. 32 * 33 * $params['name'] = (string) The name of the enrich policy 34 * 35 * @param array $params Associative array of parameters 36 * @return array 37 * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-enrich-policy-api.html 38 */ 39 public function deletePolicy(array $params = []) 40 { 41 $name = $this->extractArgument($params, 'name'); 42 43 $endpointBuilder = $this->endpoints; 44 $endpoint = $endpointBuilder('Enrich\DeletePolicy'); 45 $endpoint->setParams($params); 46 $endpoint->setName($name); 47 48 return $this->performRequest($endpoint); 49 } 50 /** 51 * Creates the enrich index for an existing enrich policy. 52 * 53 * $params['name'] = (string) The name of the enrich policy 54 * $params['wait_for_completion'] = (boolean) Should the request should block until the execution is complete. (Default = true) 55 * 56 * @param array $params Associative array of parameters 57 * @return array 58 * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/execute-enrich-policy-api.html 59 */ 60 public function executePolicy(array $params = []) 61 { 62 $name = $this->extractArgument($params, 'name'); 63 64 $endpointBuilder = $this->endpoints; 65 $endpoint = $endpointBuilder('Enrich\ExecutePolicy'); 66 $endpoint->setParams($params); 67 $endpoint->setName($name); 68 69 return $this->performRequest($endpoint); 70 } 71 /** 72 * Gets information about an enrich policy. 73 * 74 * $params['name'] = (list) A comma-separated list of enrich policy names 75 * 76 * @param array $params Associative array of parameters 77 * @return array 78 * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html 79 */ 80 public function getPolicy(array $params = []) 81 { 82 $name = $this->extractArgument($params, 'name'); 83 84 $endpointBuilder = $this->endpoints; 85 $endpoint = $endpointBuilder('Enrich\GetPolicy'); 86 $endpoint->setParams($params); 87 $endpoint->setName($name); 88 89 return $this->performRequest($endpoint); 90 } 91 /** 92 * Creates a new enrich policy. 93 * 94 * $params['name'] = (string) The name of the enrich policy 95 * $params['body'] = (array) The enrich policy to register (Required) 96 * 97 * @param array $params Associative array of parameters 98 * @return array 99 * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/put-enrich-policy-api.html 100 */ 101 public function putPolicy(array $params = []) 102 { 103 $name = $this->extractArgument($params, 'name'); 104 $body = $this->extractArgument($params, 'body'); 105 106 $endpointBuilder = $this->endpoints; 107 $endpoint = $endpointBuilder('Enrich\PutPolicy'); 108 $endpoint->setParams($params); 109 $endpoint->setName($name); 110 $endpoint->setBody($body); 111 112 return $this->performRequest($endpoint); 113 } 114 /** 115 * Gets enrich coordinator statistics and information about enrich policies that are currently executing. 116 * 117 * 118 * @param array $params Associative array of parameters 119 * @return array 120 * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-stats-api.html 121 */ 122 public function stats(array $params = []) 123 { 124 125 $endpointBuilder = $this->endpoints; 126 $endpoint = $endpointBuilder('Enrich\Stats'); 127 $endpoint->setParams($params); 128 129 return $this->performRequest($endpoint); 130 } 131} 132