Updated endpoints to 9.1.0 release

Author: ezimuel

CHANGELOG.md

@@ -1,3 +1,7 @@
+## Release 9.1.0
+
+- Updated the APIs to Elasticsearch [9.1.0](https://www.elastic.co/docs/release-notes/elasticsearch#elasticsearch-9.1.0-release-notes)
+
 ## Release 9.0.0
 
 - **Use of PHP 8.1+:** Starting from 9.0.0 the `elasticsearch-php` client requires PHP 8.1+.

src/Client.php

@@ -29,7 +29,7 @@
 final class Client implements ClientInterface
 {
     const CLIENT_NAME = 'es';
-    const VERSION = '9.0.0';
+    const VERSION = '9.1.0';
     const API_COMPATIBILITY_HEADER = '%s/vnd.elasticsearch+%s; compatible-with=9';
     const API_VERSION_HEADER = 'elastic-api-version';
     const API_VERSION = '2023-10-31';

src/Endpoints/Cluster.php

@@ -198,6 +198,8 @@ public function existsComponentTemplate(?array $params = null)
 	 *     master_timeout?: int|string, // Timeout for waiting for new cluster state in case it is blocked
 	 *     local?: bool, // Return local information, do not retrieve the state from master node (default: false)
 	 *     include_defaults?: bool, // Return all default configurations for the component template (default: false)
+	 *     flat_settings?: bool, // Return settings in flat format (default: false)
+	 *     settings_filter?: string, // Filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys
 	 *     pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false)
 	 *     human?: bool, // Return human readable values for statistics. (DEFAULT: true)
 	 *     error_trace?: bool, // Include the stack trace of returned errors. (DEFAULT: false)
@@ -221,7 +223,7 @@ public function getComponentTemplate(?array $params = null)
 			$url = '/_component_template';
 			$method = 'GET';
 		}
-		$url = $this->addQueryString($url, $params, ['master_timeout','local','include_defaults','pretty','human','error_trace','source','filter_path']);
+		$url = $this->addQueryString($url, $params, ['master_timeout','local','include_defaults','flat_settings','settings_filter','pretty','human','error_trace','source','filter_path']);
 		$headers = [
 			'Accept' => 'application/json',
 		];
@@ -446,7 +448,7 @@ public function postVotingConfigExclusions(?array $params = null)
 	 * @param array{
 	 *     name: string, // (REQUIRED) The name of the template
 	 *     create?: bool, // Whether the index template should only be added if new or can also replace an existing one
-	 *     timeout?: int|string, // Explicit operation timeout
+	 *     cause?: string, // User defined reason for create the component template
 	 *     master_timeout?: int|string, // Specify timeout for connection to master
 	 *     pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false)
 	 *     human?: bool, // Return human readable values for statistics. (DEFAULT: true)
@@ -470,7 +472,7 @@ public function putComponentTemplate(?array $params = null)
 		$url = '/_component_template/' . $this->encode($params['name']);
 		$method = 'PUT';
 
-		$url = $this->addQueryString($url, $params, ['create','timeout','master_timeout','pretty','human','error_trace','source','filter_path']);
+		$url = $this->addQueryString($url, $params, ['create','cause','master_timeout','pretty','human','error_trace','source','filter_path']);
 		$headers = [
 			'Accept' => 'application/json',
 			'Content-Type' => 'application/json',

src/Endpoints/Enrich.php

@@ -199,7 +199,7 @@ public function putPolicy(?array $params = null)
 	 * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-stats-api.html
 	 *
 	 * @param array{
-	 *     master_timeout?: int|string, // Timeout for processing on master node
+	 *     master_timeout?: int|string, // Timeout for waiting for new cluster state in case it is blocked
 	 *     pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false)
 	 *     human?: bool, // Return human readable values for statistics. (DEFAULT: true)
 	 *     error_trace?: bool, // Include the stack trace of returned errors. (DEFAULT: false)

src/Endpoints/Eql.php

@@ -160,6 +160,10 @@ public function getStatus(?array $params = null)
 	 *     keep_alive?: int|string, // Update the time interval in which the results (partial or final) for this search will be available
 	 *     allow_partial_search_results?: bool, // Control whether the query should keep running in case of shard failures, and return partial results
 	 *     allow_partial_sequence_results?: bool, // Control whether a sequence query should return partial results or no results at all in case of shard failures. This option has effect only if [allow_partial_search_results] is true.
+	 *     ccs_minimize_roundtrips?: bool, // Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
+	 *     ignore_unavailable?: bool, // Whether specified concrete indices should be ignored when unavailable (missing or closed)
+	 *     allow_no_indices?: bool, // Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
+	 *     expand_wildcards?: string, // Whether to expand wildcard expression to concrete indices that are open, closed or both.
 	 *     pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false)
 	 *     human?: bool, // Return human readable values for statistics. (DEFAULT: true)
 	 *     error_trace?: bool, // Include the stack trace of returned errors. (DEFAULT: false)
@@ -182,7 +186,7 @@ public function search(?array $params = null)
 		$url = '/' . $this->encode($params['index']) . '/_eql/search';
 		$method = empty($params['body']) ? 'GET' : 'POST';
 
-		$url = $this->addQueryString($url, $params, ['wait_for_completion_timeout','keep_on_completion','keep_alive','allow_partial_search_results','allow_partial_sequence_results','pretty','human','error_trace','source','filter_path']);
+		$url = $this->addQueryString($url, $params, ['wait_for_completion_timeout','keep_on_completion','keep_alive','allow_partial_search_results','allow_partial_sequence_results','ccs_minimize_roundtrips','ignore_unavailable','allow_no_indices','expand_wildcards','pretty','human','error_trace','source','filter_path']);
 		$headers = [
 			'Accept' => 'application/json',
 			'Content-Type' => 'application/json',

src/Endpoints/Esql.php

@@ -37,6 +37,10 @@ class Esql extends AbstractEndpoint
 	 *     format?: string, // a short version of the Accept header, e.g. json, yaml
 	 *     delimiter?: string, // The character to use between values within a CSV row. Only valid for the csv format.
 	 *     drop_null_columns?: bool, // Should entirely null columns be removed from the results? Their name and type will be returning in a new `all_columns` section.
+	 *     allow_partial_results?: bool, // If `true`, partial results will be returned if there are shard failures, but
+	 * the query can continue to execute on other clusters and shards.
+	 * If `false`, the entire query will fail if there are
+	 * any failures.
 	 *     pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false)
 	 *     human?: bool, // Return human readable values for statistics. (DEFAULT: true)
 	 *     error_trace?: bool, // Include the stack trace of returned errors. (DEFAULT: false)
@@ -58,7 +62,7 @@ public function asyncQuery(?array $params = null)
 		$url = '/_query/async';
 		$method = 'POST';
 
-		$url = $this->addQueryString($url, $params, ['format','delimiter','drop_null_columns','pretty','human','error_trace','source','filter_path']);
+		$url = $this->addQueryString($url, $params, ['format','delimiter','drop_null_columns','allow_partial_results','pretty','human','error_trace','source','filter_path']);
 		$headers = [
 			'Accept' => 'application/json',
 			'Content-Type' => 'application/json',
@@ -114,6 +118,7 @@ public function asyncQueryDelete(?array $params = null)
 	 *
 	 * @param array{
 	 *     id: string, // (REQUIRED) The async query ID
+	 *     format?: string, // a short version of the Accept header, e.g. json, yaml
 	 *     wait_for_completion_timeout?: int|string, // Specify the time that the request should block waiting for the final response
 	 *     keep_alive?: int|string, // Specify the time interval in which the results (partial or final) for this search will be available
 	 *     drop_null_columns?: bool, // Should entirely null columns be removed from the results? Their name and type will be returning in a new `all_columns` section.
@@ -138,7 +143,7 @@ public function asyncQueryGet(?array $params = null)
 		$url = '/_query/async/' . $this->encode($params['id']);
 		$method = 'GET';
 
-		$url = $this->addQueryString($url, $params, ['wait_for_completion_timeout','keep_alive','drop_null_columns','pretty','human','error_trace','source','filter_path']);
+		$url = $this->addQueryString($url, $params, ['format','wait_for_completion_timeout','keep_alive','drop_null_columns','pretty','human','error_trace','source','filter_path']);
 		$headers = [
 			'Accept' => 'application/json',
 		];
@@ -186,6 +191,83 @@ public function asyncQueryStop(?array $params = null)
 	}
 
 
+	/**
+	 * Executes a get ESQL query request
+	 *
+	 * @group serverless
+	 * @internal This API is EXPERIMENTAL and may be changed or removed completely in a future release
+	 *
+	 * @param array{
+	 *     id: string, // (REQUIRED) The query ID
+	 *     pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false)
+	 *     human?: bool, // Return human readable values for statistics. (DEFAULT: true)
+	 *     error_trace?: bool, // Include the stack trace of returned errors. (DEFAULT: false)
+	 *     source?: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
+	 *     filter_path?: string|array<string>, // A comma-separated list of filters used to reduce the response.
+	 * } $params
+	 *
+	 * @throws MissingParameterException if a required parameter is missing
+	 * @throws NoNodeAvailableException if all the hosts are offline
+	 * @throws ClientResponseException if the status code of response is 4xx
+	 * @throws ServerResponseException if the status code of response is 5xx
+	 *
+	 * @return Elasticsearch|Promise
+	 */
+	public function getQuery(?array $params = null)
+	{
+		$params = $params ?? [];
+		$this->checkRequiredParameters(['id'], $params);
+		$url = '/_query/queries/' . $this->encode($params['id']);
+		$method = 'GET';
+
+		$url = $this->addQueryString($url, $params, ['pretty','human','error_trace','source','filter_path']);
+		$headers = [
+			'Accept' => 'application/json',
+			'Content-Type' => 'application/json',
+		];
+		$request = $this->createRequest($method, $url, $headers, $params['body'] ?? null);
+		$request = $this->addOtelAttributes($params, ['id'], $request, 'esql.get_query');
+		return $this->client->sendRequest($request);
+	}
+
+
+	/**
+	 * Executes a list ESQL queries request
+	 *
+	 * @group serverless
+	 * @internal This API is EXPERIMENTAL and may be changed or removed completely in a future release
+	 *
+	 * @param array{
+	 *     pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false)
+	 *     human?: bool, // Return human readable values for statistics. (DEFAULT: true)
+	 *     error_trace?: bool, // Include the stack trace of returned errors. (DEFAULT: false)
+	 *     source?: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
+	 *     filter_path?: string|array<string>, // A comma-separated list of filters used to reduce the response.
+	 * } $params
+	 *
+	 * @throws NoNodeAvailableException if all the hosts are offline
+	 * @throws ClientResponseException if the status code of response is 4xx
+	 * @throws ServerResponseException if the status code of response is 5xx
+	 *
+	 * @return Elasticsearch|Promise
+	 */
+	public function listQueries(?array $params = null)
+	{
+		$params = $params ?? [];
+		$url = '/_query/queries';
+		$method = 'GET';
+
+		$url = $this->addQueryString($url, $params, ['pretty','human','error_trace','source','filter_path']);
+		$headers = [
+			'Accept' => 'application/json',
+			'Content-Type' => 'application/json',
+		];
+		$request = $this->createRequest($method, $url, $headers, $params['body'] ?? null);
+		$request = $this->addOtelAttributes($params, [], $request, 'esql.list_queries');
+		return $this->client->sendRequest($request);
+	}
+
+
 	/**
 	 * Executes an ESQL request
 	 *
@@ -196,6 +278,10 @@ public function asyncQueryStop(?array $params = null)
 	 *     format?: string, // a short version of the Accept header, e.g. json, yaml
 	 *     delimiter?: string, // The character to use between values within a CSV row. Only valid for the csv format.
 	 *     drop_null_columns?: bool, // Should entirely null columns be removed from the results? Their name and type will be returning in a new `all_columns` section.
+	 *     allow_partial_results?: bool, // If `true`, partial results will be returned if there are shard failures, but
+	 * the query can continue to execute on other clusters and shards.
+	 * If `false`, the entire query will fail if there are
+	 * any failures.
 	 *     pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false)
 	 *     human?: bool, // Return human readable values for statistics. (DEFAULT: true)
 	 *     error_trace?: bool, // Include the stack trace of returned errors. (DEFAULT: false)
@@ -217,7 +303,7 @@ public function query(?array $params = null)
 		$url = '/_query';
 		$method = 'POST';
 
-		$url = $this->addQueryString($url, $params, ['format','delimiter','drop_null_columns','pretty','human','error_trace','source','filter_path']);
+		$url = $this->addQueryString($url, $params, ['format','delimiter','drop_null_columns','allow_partial_results','pretty','human','error_trace','source','filter_path']);
 		$headers = [
 			'Accept' => 'application/json',
 			'Content-Type' => 'application/json',