[codegen] update to latest spec

Author: l-trotta

java-client/src/main/java/co/elastic/clients/elasticsearch/async_search/AsyncSearch.java

@@ -142,7 +142,7 @@ public static <TDocument> AsyncSearch<TDocument> of(
 
 	/**
 	 * Partial aggregations results, coming from the shards that have already
-	 * completed the execution of the query.
+	 * completed running the query.
 	 * <p>
 	 * API name: {@code aggregations}
 	 */
@@ -395,7 +395,7 @@ public static class Builder<TDocument> extends WithJsonObjectBuilderBase<Builder
 
 		/**
 		 * Partial aggregations results, coming from the shards that have already
-		 * completed the execution of the query.
+		 * completed running the query.
 		 * <p>
 		 * API name: {@code aggregations}
 		 * <p>
@@ -408,7 +408,7 @@ public final Builder<TDocument> aggregations(Map<String, Aggregate> map) {
 
 		/**
 		 * Partial aggregations results, coming from the shards that have already
-		 * completed the execution of the query.
+		 * completed running the query.
 		 * <p>
 		 * API name: {@code aggregations}
 		 * <p>
@@ -421,7 +421,7 @@ public final Builder<TDocument> aggregations(String key, Aggregate value) {
 
 		/**
 		 * Partial aggregations results, coming from the shards that have already
-		 * completed the execution of the query.
+		 * completed running the query.
 		 * <p>
 		 * API name: {@code aggregations}
 		 * <p>

java-client/src/main/java/co/elastic/clients/elasticsearch/async_search/AsyncSearchResponseBase.java

@@ -124,9 +124,13 @@ public final boolean isPartial() {
 
 	/**
 	 * Required - Indicates whether the search is still running or has completed.
-	 * NOTE: If the search failed after some shards returned their results or the
+	 * <blockquote>
+	 * <p>
+	 * info If the search failed after some shards returned their results or the
 	 * node that is coordinating the async search dies, results may be partial even
 	 * though <code>is_running</code> is <code>false</code>.
+	 * </p>
+	 * </blockquote>
 	 * <p>
 	 * API name: {@code is_running}
 	 */
@@ -167,8 +171,8 @@ public final long startTimeInMillis() {
 	}
 
 	/**
-	 * Indicates when the async search completed. Only present when the search has
-	 * completed.
+	 * Indicates when the async search completed. It is present only when the search
+	 * has completed.
 	 * <p>
 	 * API name: {@code completion_time}
 	 */
@@ -287,9 +291,13 @@ public final BuilderT isPartial(boolean value) {
 
 		/**
 		 * Required - Indicates whether the search is still running or has completed.
-		 * NOTE: If the search failed after some shards returned their results or the
+		 * <blockquote>
+		 * <p>
+		 * info If the search failed after some shards returned their results or the
 		 * node that is coordinating the async search dies, results may be partial even
 		 * though <code>is_running</code> is <code>false</code>.
+		 * </p>
+		 * </blockquote>
 		 * <p>
 		 * API name: {@code is_running}
 		 */
@@ -333,8 +341,8 @@ public final BuilderT startTimeInMillis(long value) {
 		}
 
 		/**
-		 * Indicates when the async search completed. Only present when the search has
-		 * completed.
+		 * Indicates when the async search completed. It is present only when the search
+		 * has completed.
 		 * <p>
 		 * API name: {@code completion_time}
 		 */

java-client/src/main/java/co/elastic/clients/elasticsearch/async_search/AsyncSearchStatusRequest.java

@@ -60,9 +60,15 @@
  * <p>
  * Get the status of a previously submitted async search request given its
  * identifier, without retrieving search results. If the Elasticsearch security
- * features are enabled, use of this API is restricted to the
- * <code>monitoring_user</code> role.
- * 
+ * features are enabled, the access to the status of a specific async search is
+ * restricted to:
+ * <ul>
+ * <li>The user or API key that submitted the original async search
+ * request.</li>
+ * <li>Users that have the <code>monitor</code> cluster privilege or greater
+ * privileges.</li>
+ * </ul>
+ *
  * @see <a href="../doc-files/api-spec.html#async_search.status.Request">API
  *      specification</a>
  */
@@ -96,7 +102,7 @@ public final String id() {
 	}
 
 	/**
-	 * Specifies how long the async search needs to be available. Ongoing async
+	 * The length of time that the async search needs to be available. Ongoing async
 	 * searches and any saved search results are deleted after this period.
 	 * <p>
 	 * API name: {@code keep_alive}
@@ -131,7 +137,7 @@ public final Builder id(String value) {
 		}
 
 		/**
-		 * Specifies how long the async search needs to be available. Ongoing async
+		 * The length of time that the async search needs to be available. Ongoing async
 		 * searches and any saved search results are deleted after this period.
 		 * <p>
 		 * API name: {@code keep_alive}
@@ -142,7 +148,7 @@ public final Builder keepAlive(@Nullable Time value) {
 		}
 
 		/**
-		 * Specifies how long the async search needs to be available. Ongoing async
+		 * The length of time that the async search needs to be available. Ongoing async
 		 * searches and any saved search results are deleted after this period.
 		 * <p>
 		 * API name: {@code keep_alive}

java-client/src/main/java/co/elastic/clients/elasticsearch/async_search/ElasticsearchAsyncSearchAsyncClient.java

@@ -212,9 +212,15 @@ public final <TDocument> CompletableFuture<GetAsyncSearchResponse<TDocument>> ge
 	 * <p>
 	 * Get the status of a previously submitted async search request given its
 	 * identifier, without retrieving search results. If the Elasticsearch security
-	 * features are enabled, use of this API is restricted to the
-	 * <code>monitoring_user</code> role.
-	 * 
+	 * features are enabled, the access to the status of a specific async search is
+	 * restricted to:
+	 * <ul>
+	 * <li>The user or API key that submitted the original async search
+	 * request.</li>
+	 * <li>Users that have the <code>monitor</code> cluster privilege or greater
+	 * privileges.</li>
+	 * </ul>
+	 *
 	 * @see <a href=
 	 *      "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/async-search.html">Documentation
 	 *      on elastic.co</a>
@@ -232,9 +238,15 @@ public CompletableFuture<AsyncSearchStatusResponse> status(AsyncSearchStatusRequ
 	 * <p>
 	 * Get the status of a previously submitted async search request given its
 	 * identifier, without retrieving search results. If the Elasticsearch security
-	 * features are enabled, use of this API is restricted to the
-	 * <code>monitoring_user</code> role.
-	 * 
+	 * features are enabled, the access to the status of a specific async search is
+	 * restricted to:
+	 * <ul>
+	 * <li>The user or API key that submitted the original async search
+	 * request.</li>
+	 * <li>Users that have the <code>monitor</code> cluster privilege or greater
+	 * privileges.</li>
+	 * </ul>
+	 *
 	 * @param fn
 	 *            a function that initializes a builder to create the
 	 *            {@link AsyncSearchStatusRequest}

java-client/src/main/java/co/elastic/clients/elasticsearch/async_search/ElasticsearchAsyncSearchClient.java

@@ -214,9 +214,15 @@ public final <TDocument> GetAsyncSearchResponse<TDocument> get(
 	 * <p>
 	 * Get the status of a previously submitted async search request given its
 	 * identifier, without retrieving search results. If the Elasticsearch security
-	 * features are enabled, use of this API is restricted to the
-	 * <code>monitoring_user</code> role.
-	 * 
+	 * features are enabled, the access to the status of a specific async search is
+	 * restricted to:
+	 * <ul>
+	 * <li>The user or API key that submitted the original async search
+	 * request.</li>
+	 * <li>Users that have the <code>monitor</code> cluster privilege or greater
+	 * privileges.</li>
+	 * </ul>
+	 *
 	 * @see <a href=
 	 *      "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/async-search.html">Documentation
 	 *      on elastic.co</a>
@@ -235,9 +241,15 @@ public AsyncSearchStatusResponse status(AsyncSearchStatusRequest request)
 	 * <p>
 	 * Get the status of a previously submitted async search request given its
 	 * identifier, without retrieving search results. If the Elasticsearch security
-	 * features are enabled, use of this API is restricted to the
-	 * <code>monitoring_user</code> role.
-	 * 
+	 * features are enabled, the access to the status of a specific async search is
+	 * restricted to:
+	 * <ul>
+	 * <li>The user or API key that submitted the original async search
+	 * request.</li>
+	 * <li>Users that have the <code>monitor</code> cluster privilege or greater
+	 * privileges.</li>
+	 * </ul>
+	 *
 	 * @param fn
 	 *            a function that initializes a builder to create the
 	 *            {@link AsyncSearchStatusRequest}

java-client/src/main/java/co/elastic/clients/elasticsearch/async_search/GetAsyncSearchRequest.java

@@ -100,12 +100,12 @@ public final String id() {
 	}
 
 	/**
-	 * Specifies how long the async search should be available in the cluster. When
-	 * not specified, the <code>keep_alive</code> set with the corresponding submit
-	 * async request will be used. Otherwise, it is possible to override the value
-	 * and extend the validity of the request. When this period expires, the search,
-	 * if still running, is cancelled. If the search is completed, its saved results
-	 * are deleted.
+	 * The length of time that the async search should be available in the cluster.
+	 * When not specified, the <code>keep_alive</code> set with the corresponding
+	 * submit async request will be used. Otherwise, it is possible to override the
+	 * value and extend the validity of the request. When this period expires, the
+	 * search, if still running, is cancelled. If the search is completed, its saved
+	 * results are deleted.
 	 * <p>
 	 * API name: {@code keep_alive}
 	 */
@@ -156,12 +156,12 @@ public final Builder id(String value) {
 		}
 
 		/**
-		 * Specifies how long the async search should be available in the cluster. When
-		 * not specified, the <code>keep_alive</code> set with the corresponding submit
-		 * async request will be used. Otherwise, it is possible to override the value
-		 * and extend the validity of the request. When this period expires, the search,
-		 * if still running, is cancelled. If the search is completed, its saved results
-		 * are deleted.
+		 * The length of time that the async search should be available in the cluster.
+		 * When not specified, the <code>keep_alive</code> set with the corresponding
+		 * submit async request will be used. Otherwise, it is possible to override the
+		 * value and extend the validity of the request. When this period expires, the
+		 * search, if still running, is cancelled. If the search is completed, its saved
+		 * results are deleted.
 		 * <p>
 		 * API name: {@code keep_alive}
 		 */
@@ -171,12 +171,12 @@ public final Builder keepAlive(@Nullable Time value) {
 		}
 
 		/**
-		 * Specifies how long the async search should be available in the cluster. When
-		 * not specified, the <code>keep_alive</code> set with the corresponding submit
-		 * async request will be used. Otherwise, it is possible to override the value
-		 * and extend the validity of the request. When this period expires, the search,
-		 * if still running, is cancelled. If the search is completed, its saved results
-		 * are deleted.
+		 * The length of time that the async search should be available in the cluster.
+		 * When not specified, the <code>keep_alive</code> set with the corresponding
+		 * submit async request will be used. Otherwise, it is possible to override the
+		 * value and extend the validity of the request. When this period expires, the
+		 * search, if still running, is cancelled. If the search is completed, its saved
+		 * results are deleted.
 		 * <p>
 		 * API name: {@code keep_alive}
 		 */

java-client/src/main/java/co/elastic/clients/elasticsearch/async_search/status/StatusResponseBase.java

@@ -81,7 +81,7 @@ protected StatusResponseBase(AbstractBuilder<?> builder) {
 	}
 
 	/**
-	 * Required - Indicates how many shards have run the query so far.
+	 * Required - The number of shards that have run the query so far.
 	 * <p>
 	 * API name: {@code _shards}
 	 */
@@ -90,8 +90,8 @@ public final ShardStatistics shards() {
 	}
 
 	/**
-	 * Metadata about clusters involved in the cross-cluster search. Not shown for
-	 * local-only searches.
+	 * Metadata about clusters involved in the cross-cluster search. It is not shown
+	 * for local-only searches.
 	 * <p>
 	 * API name: {@code _clusters}
 	 */
@@ -102,8 +102,9 @@ public final ClusterStatistics clusters() {
 
 	/**
 	 * If the async search completed, this field shows the status code of the
-	 * search. For example, 200 indicates that the async search was successfully
-	 * completed. 503 indicates that the async search was completed with an error.
+	 * search. For example, <code>200</code> indicates that the async search was
+	 * successfully completed. <code>503</code> indicates that the async search was
+	 * completed with an error.
 	 * <p>
 	 * API name: {@code completion_status}
 	 */
@@ -143,7 +144,7 @@ public abstract static class AbstractBuilder<BuilderT extends AbstractBuilder<Bu
 		private Integer completionStatus;
 
 		/**
-		 * Required - Indicates how many shards have run the query so far.
+		 * Required - The number of shards that have run the query so far.
 		 * <p>
 		 * API name: {@code _shards}
 		 */
@@ -153,7 +154,7 @@ public final BuilderT shards(ShardStatistics value) {
 		}
 
 		/**
-		 * Required - Indicates how many shards have run the query so far.
+		 * Required - The number of shards that have run the query so far.
 		 * <p>
 		 * API name: {@code _shards}
 		 */
@@ -162,8 +163,8 @@ public final BuilderT shards(Function<ShardStatistics.Builder, ObjectBuilder<Sha
 		}
 
 		/**
-		 * Metadata about clusters involved in the cross-cluster search. Not shown for
-		 * local-only searches.
+		 * Metadata about clusters involved in the cross-cluster search. It is not shown
+		 * for local-only searches.
 		 * <p>
 		 * API name: {@code _clusters}
 		 */
@@ -173,8 +174,8 @@ public final BuilderT clusters(@Nullable ClusterStatistics value) {
 		}
 
 		/**
-		 * Metadata about clusters involved in the cross-cluster search. Not shown for
-		 * local-only searches.
+		 * Metadata about clusters involved in the cross-cluster search. It is not shown
+		 * for local-only searches.
 		 * <p>
 		 * API name: {@code _clusters}
 		 */
@@ -184,8 +185,9 @@ public final BuilderT clusters(Function<ClusterStatistics.Builder, ObjectBuilder
 
 		/**
 		 * If the async search completed, this field shows the status code of the
-		 * search. For example, 200 indicates that the async search was successfully
-		 * completed. 503 indicates that the async search was completed with an error.
+		 * search. For example, <code>200</code> indicates that the async search was
+		 * successfully completed. <code>503</code> indicates that the async search was
+		 * completed with an error.
 		 * <p>
 		 * API name: {@code completion_status}
 		 */