diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ElasticsearchAsyncClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ElasticsearchAsyncClient.java index bbddcaa739..a39d237fb3 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ElasticsearchAsyncClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ElasticsearchAsyncClient.java @@ -378,10 +378,11 @@ public ElasticsearchXpackAsyncClient xpack() { // ----- Endpoint: bulk /** - * Bulk index or delete documents. Perform multiple index, - * create, delete, and update actions in - * a single request. This reduces overhead and can greatly increase indexing - * speed. + * Bulk index or delete documents. + *

+ * Perform multiple index, create, + * delete, and update actions in a single request. + * This reduces overhead and can greatly increase indexing speed. *

* If the Elasticsearch security features are enabled, you must have the * following index privileges for the target data stream, index, or index alias: @@ -557,10 +558,11 @@ public CompletableFuture bulk(BulkRequest request) { } /** - * Bulk index or delete documents. Perform multiple index, - * create, delete, and update actions in - * a single request. This reduces overhead and can greatly increase indexing - * speed. + * Bulk index or delete documents. + *

+ * Perform multiple index, create, + * delete, and update actions in a single request. + * This reduces overhead and can greatly increase indexing speed. *

* If the Elasticsearch security features are enabled, you must have the * following index privileges for the target data stream, index, or index alias: @@ -736,10 +738,11 @@ public final CompletableFuture bulk(Functionindex, - * create, delete, and update actions in - * a single request. This reduces overhead and can greatly increase indexing - * speed. + * Bulk index or delete documents. + *

+ * Perform multiple index, create, + * delete, and update actions in a single request. + * This reduces overhead and can greatly increase indexing speed. *

* If the Elasticsearch security features are enabled, you must have the * following index privileges for the target data stream, index, or index alias: @@ -915,8 +918,9 @@ public CompletableFuture bulk() { // ----- Endpoint: clear_scroll /** - * Clear a scrolling search. Clear the search context and results for a - * scrolling search. + * Clear a scrolling search. + *

+ * Clear the search context and results for a scrolling search. * * @see Documentation @@ -931,8 +935,9 @@ public CompletableFuture clearScroll(ClearScrollRequest req } /** - * Clear a scrolling search. Clear the search context and results for a - * scrolling search. + * Clear a scrolling search. + *

+ * Clear the search context and results for a scrolling search. * * @param fn * a function that initializes a builder to create the @@ -948,8 +953,9 @@ public final CompletableFuture clearScroll( } /** - * Clear a scrolling search. Clear the search context and results for a - * scrolling search. + * Clear a scrolling search. + *

+ * Clear the search context and results for a scrolling search. * * @see Documentation @@ -964,12 +970,14 @@ public CompletableFuture clearScroll() { // ----- Endpoint: close_point_in_time /** - * Close a point in time. A point in time must be opened explicitly before being - * used in search requests. The keep_alive parameter tells - * Elasticsearch how long it should persist. A point in time is automatically - * closed when the keep_alive period has elapsed. However, keeping - * points in time has a cost; close them as soon as they are no longer required - * for search requests. + * Close a point in time. + *

+ * A point in time must be opened explicitly before being used in search + * requests. The keep_alive parameter tells Elasticsearch how long + * it should persist. A point in time is automatically closed when the + * keep_alive period has elapsed. However, keeping points in time + * has a cost; close them as soon as they are no longer required for search + * requests. * * @see Documentation @@ -984,12 +992,14 @@ public CompletableFuture closePointInTime(ClosePointIn } /** - * Close a point in time. A point in time must be opened explicitly before being - * used in search requests. The keep_alive parameter tells - * Elasticsearch how long it should persist. A point in time is automatically - * closed when the keep_alive period has elapsed. However, keeping - * points in time has a cost; close them as soon as they are no longer required - * for search requests. + * Close a point in time. + *

+ * A point in time must be opened explicitly before being used in search + * requests. The keep_alive parameter tells Elasticsearch how long + * it should persist. A point in time is automatically closed when the + * keep_alive period has elapsed. However, keeping points in time + * has a cost; close them as soon as they are no longer required for search + * requests. * * @param fn * a function that initializes a builder to create the @@ -1007,7 +1017,9 @@ public final CompletableFuture closePointInTime( // ----- Endpoint: count /** - * Count search results. Get the number of documents matching a query. + * Count search results. + *

+ * Get the number of documents matching a query. *

* The query can be provided either by using a simple query string as a * parameter, or by defining Query DSL within the request body. The query is @@ -1034,7 +1046,9 @@ public CompletableFuture count(CountRequest request) { } /** - * Count search results. Get the number of documents matching a query. + * Count search results. + *

+ * Get the number of documents matching a query. *

* The query can be provided either by using a simple query string as a * parameter, or by defining Query DSL within the request body. The query is @@ -1062,7 +1076,9 @@ public final CompletableFuture count( } /** - * Count search results. Get the number of documents matching a query. + * Count search results. + *

+ * Get the number of documents matching a query. *

* The query can be provided either by using a simple query string as a * parameter, or by defining Query DSL within the request body. The query is @@ -1834,8 +1850,9 @@ public final CompletableFuture deleteByQueryRet // ----- Endpoint: delete_script /** - * Delete a script or search template. Deletes a stored script or search - * template. + * Delete a script or search template. + *

+ * Deletes a stored script or search template. * * @see Documentation @@ -1850,8 +1867,9 @@ public CompletableFuture deleteScript(DeleteScriptRequest } /** - * Delete a script or search template. Deletes a stored script or search - * template. + * Delete a script or search template. + *

+ * Deletes a stored script or search template. * * @param fn * a function that initializes a builder to create the @@ -1997,9 +2015,10 @@ public final CompletableFuture existsSource( // ----- Endpoint: explain /** - * Explain a document match result. Get information about why a specific - * document matches, or doesn't match, a query. It computes a score explanation - * for a query and a specific document. + * Explain a document match result. + *

+ * Get information about why a specific document matches, or doesn't match, a + * query. It computes a score explanation for a query and a specific document. * * @see Documentation @@ -2017,9 +2036,10 @@ public CompletableFuture> explain(Explain } /** - * Explain a document match result. Get information about why a specific - * document matches, or doesn't match, a query. It computes a score explanation - * for a query and a specific document. + * Explain a document match result. + *

+ * Get information about why a specific document matches, or doesn't match, a + * query. It computes a score explanation for a query and a specific document. * * @param fn * a function that initializes a builder to create the @@ -2056,9 +2076,10 @@ public final CompletableFuture> explain( } /** - * Explain a document match result. Get information about why a specific - * document matches, or doesn't match, a query. It computes a score explanation - * for a query and a specific document. + * Explain a document match result. + *

+ * Get information about why a specific document matches, or doesn't match, a + * query. It computes a score explanation for a query and a specific document. * * @see Documentation @@ -2076,9 +2097,10 @@ public CompletableFuture> explain(Explain } /** - * Explain a document match result. Get information about why a specific - * document matches, or doesn't match, a query. It computes a score explanation - * for a query and a specific document. + * Explain a document match result. + *

+ * Get information about why a specific document matches, or doesn't match, a + * query. It computes a score explanation for a query and a specific document. * * @param fn * a function that initializes a builder to create the @@ -2536,8 +2558,9 @@ public final CompletableFuture> get( // ----- Endpoint: get_script /** - * Get a script or search template. Retrieves a stored script or search - * template. + * Get a script or search template. + *

+ * Retrieves a stored script or search template. * * @see Documentation @@ -2552,8 +2575,9 @@ public CompletableFuture getScript(GetScriptRequest request) } /** - * Get a script or search template. Retrieves a stored script or search - * template. + * Get a script or search template. + *

+ * Retrieves a stored script or search template. * * @param fn * a function that initializes a builder to create the @@ -2756,9 +2780,10 @@ public final CompletableFuture> getSour // ----- Endpoint: health_report /** - * Get the cluster health. Get a report with the health status of an - * Elasticsearch cluster. The report contains a list of indicators that compose - * Elasticsearch functionality. + * Get the cluster health. + *

+ * Get a report with the health status of an Elasticsearch cluster. The report + * contains a list of indicators that compose Elasticsearch functionality. *

* Each indicator has a health status of: green, unknown, yellow or red. The * indicator will provide an explanation and metadata describing the reason for @@ -2798,9 +2823,10 @@ public CompletableFuture healthReport(HealthReportRequest } /** - * Get the cluster health. Get a report with the health status of an - * Elasticsearch cluster. The report contains a list of indicators that compose - * Elasticsearch functionality. + * Get the cluster health. + *

+ * Get a report with the health status of an Elasticsearch cluster. The report + * contains a list of indicators that compose Elasticsearch functionality. *

* Each indicator has a health status of: green, unknown, yellow or red. The * indicator will provide an explanation and metadata describing the reason for @@ -2841,9 +2867,10 @@ public final CompletableFuture healthReport( } /** - * Get the cluster health. Get a report with the health status of an - * Elasticsearch cluster. The report contains a list of indicators that compose - * Elasticsearch functionality. + * Get the cluster health. + *

+ * Get a report with the health status of an Elasticsearch cluster. The report + * contains a list of indicators that compose Elasticsearch functionality. *

* Each indicator has a health status of: green, unknown, yellow or red. The * indicator will provide an explanation and metadata describing the reason for @@ -3292,9 +3319,11 @@ public final CompletableFuture index( // ----- Endpoint: info /** - * Get cluster info. Get basic build, version, and cluster information. ::: In - * Serverless, this API is retained for backward compatibility only. Some - * response fields, such as the version number, should be ignored. + * Get cluster info. + *

+ * Get basic build, version, and cluster information. ::: In Serverless, this + * API is retained for backward compatibility only. Some response fields, such + * as the version number, should be ignored. * * @see Documentation @@ -4043,7 +4072,9 @@ public final CompletableFuture openPointInTime( // ----- Endpoint: ping /** - * Ping the cluster. Get information about whether the cluster is running. + * Ping the cluster. + *

+ * Get information about whether the cluster is running. * * @see Documentation @@ -4056,8 +4087,9 @@ public CompletableFuture ping() { // ----- Endpoint: put_script /** - * Create or update a script or search template. Creates or updates a stored - * script or search template. + * Create or update a script or search template. + *

+ * Creates or updates a stored script or search template. * * @see Documentation @@ -4072,8 +4104,9 @@ public CompletableFuture putScript(PutScriptRequest request) } /** - * Create or update a script or search template. Creates or updates a stored - * script or search template. + * Create or update a script or search template. + *

+ * Creates or updates a stored script or search template. * * @param fn * a function that initializes a builder to create the @@ -6135,10 +6168,11 @@ public final CompletableFuture + * Updates documents that match the specified query. If no query is specified, + * performs an update on every document in the data stream or index without + * modifying the source, which is useful for picking up mapping changes. *

* If the Elasticsearch security features are enabled, you must have the * following index privileges for the target data stream, index, or alias: @@ -6296,10 +6330,11 @@ public CompletableFuture updateByQuery(UpdateByQueryReque } /** - * Update documents. Updates documents that match the specified query. If no - * query is specified, performs an update on every document in the data stream - * or index without modifying the source, which is useful for picking up mapping - * changes. + * Update documents. + *

+ * Updates documents that match the specified query. If no query is specified, + * performs an update on every document in the data stream or index without + * modifying the source, which is useful for picking up mapping changes. *

* If the Elasticsearch security features are enabled, you must have the * following index privileges for the target data stream, index, or alias: diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ElasticsearchClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ElasticsearchClient.java index 6cad8a2fb2..084b2393d4 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ElasticsearchClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ElasticsearchClient.java @@ -378,10 +378,11 @@ public ElasticsearchXpackClient xpack() { // ----- Endpoint: bulk /** - * Bulk index or delete documents. Perform multiple index, - * create, delete, and update actions in - * a single request. This reduces overhead and can greatly increase indexing - * speed. + * Bulk index or delete documents. + *

+ * Perform multiple index, create, + * delete, and update actions in a single request. + * This reduces overhead and can greatly increase indexing speed. *

* If the Elasticsearch security features are enabled, you must have the * following index privileges for the target data stream, index, or index alias: @@ -557,10 +558,11 @@ public BulkResponse bulk(BulkRequest request) throws IOException, ElasticsearchE } /** - * Bulk index or delete documents. Perform multiple index, - * create, delete, and update actions in - * a single request. This reduces overhead and can greatly increase indexing - * speed. + * Bulk index or delete documents. + *

+ * Perform multiple index, create, + * delete, and update actions in a single request. + * This reduces overhead and can greatly increase indexing speed. *

* If the Elasticsearch security features are enabled, you must have the * following index privileges for the target data stream, index, or index alias: @@ -737,10 +739,11 @@ public final BulkResponse bulk(Functionindex, - * create, delete, and update actions in - * a single request. This reduces overhead and can greatly increase indexing - * speed. + * Bulk index or delete documents. + *

+ * Perform multiple index, create, + * delete, and update actions in a single request. + * This reduces overhead and can greatly increase indexing speed. *

* If the Elasticsearch security features are enabled, you must have the * following index privileges for the target data stream, index, or index alias: @@ -916,8 +919,9 @@ public BulkResponse bulk() throws IOException, ElasticsearchException { // ----- Endpoint: clear_scroll /** - * Clear a scrolling search. Clear the search context and results for a - * scrolling search. + * Clear a scrolling search. + *

+ * Clear the search context and results for a scrolling search. * * @see Documentation @@ -932,8 +936,9 @@ public ClearScrollResponse clearScroll(ClearScrollRequest request) throws IOExce } /** - * Clear a scrolling search. Clear the search context and results for a - * scrolling search. + * Clear a scrolling search. + *

+ * Clear the search context and results for a scrolling search. * * @param fn * a function that initializes a builder to create the @@ -950,8 +955,9 @@ public final ClearScrollResponse clearScroll( } /** - * Clear a scrolling search. Clear the search context and results for a - * scrolling search. + * Clear a scrolling search. + *

+ * Clear the search context and results for a scrolling search. * * @see Documentation @@ -966,12 +972,14 @@ public ClearScrollResponse clearScroll() throws IOException, ElasticsearchExcept // ----- Endpoint: close_point_in_time /** - * Close a point in time. A point in time must be opened explicitly before being - * used in search requests. The keep_alive parameter tells - * Elasticsearch how long it should persist. A point in time is automatically - * closed when the keep_alive period has elapsed. However, keeping - * points in time has a cost; close them as soon as they are no longer required - * for search requests. + * Close a point in time. + *

+ * A point in time must be opened explicitly before being used in search + * requests. The keep_alive parameter tells Elasticsearch how long + * it should persist. A point in time is automatically closed when the + * keep_alive period has elapsed. However, keeping points in time + * has a cost; close them as soon as they are no longer required for search + * requests. * * @see Documentation @@ -987,12 +995,14 @@ public ClosePointInTimeResponse closePointInTime(ClosePointInTimeRequest request } /** - * Close a point in time. A point in time must be opened explicitly before being - * used in search requests. The keep_alive parameter tells - * Elasticsearch how long it should persist. A point in time is automatically - * closed when the keep_alive period has elapsed. However, keeping - * points in time has a cost; close them as soon as they are no longer required - * for search requests. + * Close a point in time. + *

+ * A point in time must be opened explicitly before being used in search + * requests. The keep_alive parameter tells Elasticsearch how long + * it should persist. A point in time is automatically closed when the + * keep_alive period has elapsed. However, keeping points in time + * has a cost; close them as soon as they are no longer required for search + * requests. * * @param fn * a function that initializes a builder to create the @@ -1011,7 +1021,9 @@ public final ClosePointInTimeResponse closePointInTime( // ----- Endpoint: count /** - * Count search results. Get the number of documents matching a query. + * Count search results. + *

+ * Get the number of documents matching a query. *

* The query can be provided either by using a simple query string as a * parameter, or by defining Query DSL within the request body. The query is @@ -1038,7 +1050,9 @@ public CountResponse count(CountRequest request) throws IOException, Elasticsear } /** - * Count search results. Get the number of documents matching a query. + * Count search results. + *

+ * Get the number of documents matching a query. *

* The query can be provided either by using a simple query string as a * parameter, or by defining Query DSL within the request body. The query is @@ -1066,7 +1080,9 @@ public final CountResponse count(Function + * Get the number of documents matching a query. *

* The query can be provided either by using a simple query string as a * parameter, or by defining Query DSL within the request body. The query is @@ -1843,8 +1859,9 @@ public final DeleteByQueryRethrottleResponse deleteByQueryRethrottle( // ----- Endpoint: delete_script /** - * Delete a script or search template. Deletes a stored script or search - * template. + * Delete a script or search template. + *

+ * Deletes a stored script or search template. * * @see Documentation @@ -1859,8 +1876,9 @@ public DeleteScriptResponse deleteScript(DeleteScriptRequest request) throws IOE } /** - * Delete a script or search template. Deletes a stored script or search - * template. + * Delete a script or search template. + *

+ * Deletes a stored script or search template. * * @param fn * a function that initializes a builder to create the @@ -2008,9 +2026,10 @@ public final BooleanResponse existsSource( // ----- Endpoint: explain /** - * Explain a document match result. Get information about why a specific - * document matches, or doesn't match, a query. It computes a score explanation - * for a query and a specific document. + * Explain a document match result. + *

+ * Get information about why a specific document matches, or doesn't match, a + * query. It computes a score explanation for a query and a specific document. * * @see Documentation @@ -2028,9 +2047,10 @@ public ExplainResponse explain(ExplainRequest request, Cl } /** - * Explain a document match result. Get information about why a specific - * document matches, or doesn't match, a query. It computes a score explanation - * for a query and a specific document. + * Explain a document match result. + *

+ * Get information about why a specific document matches, or doesn't match, a + * query. It computes a score explanation for a query and a specific document. * * @param fn * a function that initializes a builder to create the @@ -2068,9 +2088,10 @@ public final ExplainResponse explain(Function + * Get information about why a specific document matches, or doesn't match, a + * query. It computes a score explanation for a query and a specific document. * * @see Documentation @@ -2088,9 +2109,10 @@ public ExplainResponse explain(ExplainRequest request, Ty } /** - * Explain a document match result. Get information about why a specific - * document matches, or doesn't match, a query. It computes a score explanation - * for a query and a specific document. + * Explain a document match result. + *

+ * Get information about why a specific document matches, or doesn't match, a + * query. It computes a score explanation for a query and a specific document. * * @param fn * a function that initializes a builder to create the @@ -2551,8 +2573,9 @@ public final GetResponse get(Function + * Retrieves a stored script or search template. * * @see Documentation @@ -2567,8 +2590,9 @@ public GetScriptResponse getScript(GetScriptRequest request) throws IOException, } /** - * Get a script or search template. Retrieves a stored script or search - * template. + * Get a script or search template. + *

+ * Retrieves a stored script or search template. * * @param fn * a function that initializes a builder to create the @@ -2774,9 +2798,10 @@ public final GetSourceResponse getSource( // ----- Endpoint: health_report /** - * Get the cluster health. Get a report with the health status of an - * Elasticsearch cluster. The report contains a list of indicators that compose - * Elasticsearch functionality. + * Get the cluster health. + *

+ * Get a report with the health status of an Elasticsearch cluster. The report + * contains a list of indicators that compose Elasticsearch functionality. *

* Each indicator has a health status of: green, unknown, yellow or red. The * indicator will provide an explanation and metadata describing the reason for @@ -2816,9 +2841,10 @@ public HealthReportResponse healthReport(HealthReportRequest request) throws IOE } /** - * Get the cluster health. Get a report with the health status of an - * Elasticsearch cluster. The report contains a list of indicators that compose - * Elasticsearch functionality. + * Get the cluster health. + *

+ * Get a report with the health status of an Elasticsearch cluster. The report + * contains a list of indicators that compose Elasticsearch functionality. *

* Each indicator has a health status of: green, unknown, yellow or red. The * indicator will provide an explanation and metadata describing the reason for @@ -2860,9 +2886,10 @@ public final HealthReportResponse healthReport( } /** - * Get the cluster health. Get a report with the health status of an - * Elasticsearch cluster. The report contains a list of indicators that compose - * Elasticsearch functionality. + * Get the cluster health. + *

+ * Get a report with the health status of an Elasticsearch cluster. The report + * contains a list of indicators that compose Elasticsearch functionality. *

* Each indicator has a health status of: green, unknown, yellow or red. The * indicator will provide an explanation and metadata describing the reason for @@ -3312,9 +3339,11 @@ public final IndexResponse index( // ----- Endpoint: info /** - * Get cluster info. Get basic build, version, and cluster information. ::: In - * Serverless, this API is retained for backward compatibility only. Some - * response fields, such as the version number, should be ignored. + * Get cluster info. + *

+ * Get basic build, version, and cluster information. ::: In Serverless, this + * API is retained for backward compatibility only. Some response fields, such + * as the version number, should be ignored. * * @see Documentation @@ -4072,7 +4101,9 @@ public final OpenPointInTimeResponse openPointInTime( // ----- Endpoint: ping /** - * Ping the cluster. Get information about whether the cluster is running. + * Ping the cluster. + *

+ * Get information about whether the cluster is running. * * @see Documentation @@ -4085,8 +4116,9 @@ public BooleanResponse ping() throws IOException, ElasticsearchException { // ----- Endpoint: put_script /** - * Create or update a script or search template. Creates or updates a stored - * script or search template. + * Create or update a script or search template. + *

+ * Creates or updates a stored script or search template. * * @see Documentation @@ -4101,8 +4133,9 @@ public PutScriptResponse putScript(PutScriptRequest request) throws IOException, } /** - * Create or update a script or search template. Creates or updates a stored - * script or search template. + * Create or update a script or search template. + *

+ * Creates or updates a stored script or search template. * * @param fn * a function that initializes a builder to create the @@ -6184,10 +6217,11 @@ public final UpdateResponse update( // ----- Endpoint: update_by_query /** - * Update documents. Updates documents that match the specified query. If no - * query is specified, performs an update on every document in the data stream - * or index without modifying the source, which is useful for picking up mapping - * changes. + * Update documents. + *

+ * Updates documents that match the specified query. If no query is specified, + * performs an update on every document in the data stream or index without + * modifying the source, which is useful for picking up mapping changes. *

* If the Elasticsearch security features are enabled, you must have the * following index privileges for the target data stream, index, or alias: @@ -6346,10 +6380,11 @@ public UpdateByQueryResponse updateByQuery(UpdateByQueryRequest request) } /** - * Update documents. Updates documents that match the specified query. If no - * query is specified, performs an update on every document in the data stream - * or index without modifying the source, which is useful for picking up mapping - * changes. + * Update documents. + *

+ * Updates documents that match the specified query. If no query is specified, + * performs an update on every document in the data stream or index without + * modifying the source, which is useful for picking up mapping changes. *

* If the Elasticsearch security features are enabled, you must have the * following index privileges for the target data stream, index, or alias: diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/async_search/AsyncSearchResponseBase.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/async_search/AsyncSearchResponseBase.java index 847f538977..4d21f812c3 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/async_search/AsyncSearchResponseBase.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/async_search/AsyncSearchResponseBase.java @@ -19,6 +19,7 @@ package co.elastic.clients.elasticsearch.async_search; +import co.elastic.clients.elasticsearch._types.ErrorCause; import co.elastic.clients.json.JsonpDeserializable; import co.elastic.clients.json.JsonpDeserializer; import co.elastic.clients.json.JsonpMapper; @@ -35,6 +36,7 @@ import java.lang.Long; import java.lang.String; import java.util.Objects; +import java.util.function.Function; import javax.annotation.Nullable; //---------------------------------------------------------------- @@ -85,6 +87,9 @@ public abstract class AsyncSearchResponseBase implements JsonpSerializable { @Nullable private final Long completionTimeInMillis; + @Nullable + private final ErrorCause error; + // --------------------------------------------------------------------------------------------- protected AsyncSearchResponseBase(AbstractBuilder builder) { @@ -99,6 +104,7 @@ protected AsyncSearchResponseBase(AbstractBuilder builder) { this.startTimeInMillis = ApiTypeHelper.requireNonNull(builder.startTimeInMillis, this, "startTimeInMillis", 0); this.completionTime = builder.completionTime; this.completionTimeInMillis = builder.completionTimeInMillis; + this.error = builder.error; } @@ -189,6 +195,14 @@ public final Long completionTimeInMillis() { return this.completionTimeInMillis; } + /** + * API name: {@code error} + */ + @Nullable + public final ErrorCause error() { + return this.error; + } + /** * Serialize this object to JSON. */ @@ -234,6 +248,11 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) { generator.write(this.completionTimeInMillis); } + if (this.error != null) { + generator.writeKey("error"); + this.error.serialize(generator, mapper); + + } } @@ -268,6 +287,9 @@ public abstract static class AbstractBuilder> fn) { + return this.error(fn.apply(new ErrorCause.Builder()).build()); + } + protected abstract BuilderT self(); } @@ -378,6 +415,7 @@ protected static > void setupAsyncSea op.add(AbstractBuilder::completionTime, DateTime._DESERIALIZER, "completion_time"); op.add(AbstractBuilder::completionTimeInMillis, JsonpDeserializer.longDeserializer(), "completion_time_in_millis"); + op.add(AbstractBuilder::error, ErrorCause._DESERIALIZER, "error"); } diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/ElasticsearchCcrAsyncClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/ElasticsearchCcrAsyncClient.java index d3dde85f64..ba876ee09d 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/ElasticsearchCcrAsyncClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/ElasticsearchCcrAsyncClient.java @@ -105,10 +105,12 @@ public final CompletableFuture deleteAutoFollow // ----- Endpoint: ccr.follow /** - * Create a follower. Create a cross-cluster replication follower index that - * follows a specific leader index. When the API returns, the follower index - * exists and cross-cluster replication starts replicating operations from the - * leader index to the follower index. + * Create a follower. + *

+ * Create a cross-cluster replication follower index that follows a specific + * leader index. When the API returns, the follower index exists and + * cross-cluster replication starts replicating operations from the leader index + * to the follower index. * * @see Documentation @@ -123,10 +125,12 @@ public CompletableFuture follow(FollowRequest request) { } /** - * Create a follower. Create a cross-cluster replication follower index that - * follows a specific leader index. When the API returns, the follower index - * exists and cross-cluster replication starts replicating operations from the - * leader index to the follower index. + * Create a follower. + *

+ * Create a cross-cluster replication follower index that follows a specific + * leader index. When the API returns, the follower index exists and + * cross-cluster replication starts replicating operations from the leader index + * to the follower index. * * @param fn * a function that initializes a builder to create the @@ -226,8 +230,10 @@ public final CompletableFuture followStats( // ----- Endpoint: ccr.forget_follower /** - * Forget a follower. Remove the cross-cluster replication follower retention - * leases from the leader. + * Forget a follower. + *

+ * Remove the cross-cluster replication follower retention leases from the + * leader. *

* A following index takes out retention leases on its leader index. These * leases are used to increase the likelihood that the shards of the leader @@ -261,8 +267,10 @@ public CompletableFuture forgetFollower(ForgetFollowerRe } /** - * Forget a follower. Remove the cross-cluster replication follower retention - * leases from the leader. + * Forget a follower. + *

+ * Remove the cross-cluster replication follower retention leases from the + * leader. *

* A following index takes out retention leases on its leader index. These * leases are used to increase the likelihood that the shards of the leader @@ -450,12 +458,13 @@ public final CompletableFuture pauseFollow( // ----- Endpoint: ccr.put_auto_follow_pattern /** - * Create or update auto-follow patterns. Create a collection of cross-cluster - * replication auto-follow patterns for a remote cluster. Newly created indices - * on the remote cluster that match any of the patterns are automatically - * configured as follower indices. Indices on the remote cluster that were - * created before the auto-follow pattern was created will not be auto-followed - * even if they match the pattern. + * Create or update auto-follow patterns. + *

+ * Create a collection of cross-cluster replication auto-follow patterns for a + * remote cluster. Newly created indices on the remote cluster that match any of + * the patterns are automatically configured as follower indices. Indices on the + * remote cluster that were created before the auto-follow pattern was created + * will not be auto-followed even if they match the pattern. *

* This API can also be used to update auto-follow patterns. NOTE: Follower * indices that were configured automatically before updating an auto-follow @@ -475,12 +484,13 @@ public CompletableFuture putAutoFollowPattern(PutA } /** - * Create or update auto-follow patterns. Create a collection of cross-cluster - * replication auto-follow patterns for a remote cluster. Newly created indices - * on the remote cluster that match any of the patterns are automatically - * configured as follower indices. Indices on the remote cluster that were - * created before the auto-follow pattern was created will not be auto-followed - * even if they match the pattern. + * Create or update auto-follow patterns. + *

+ * Create a collection of cross-cluster replication auto-follow patterns for a + * remote cluster. Newly created indices on the remote cluster that match any of + * the patterns are automatically configured as follower indices. Indices on the + * remote cluster that were created before the auto-follow pattern was created + * will not be auto-followed even if they match the pattern. *

* This API can also be used to update auto-follow patterns. NOTE: Follower * indices that were configured automatically before updating an auto-follow @@ -549,11 +559,13 @@ public final CompletableFuture resumeAutoFollow // ----- Endpoint: ccr.resume_follow /** - * Resume a follower. Resume a cross-cluster replication follower index that was - * paused. The follower index could have been paused with the pause follower - * API. Alternatively it could be paused due to replication that cannot be - * retried due to failures during following tasks. When this API returns, the - * follower index will resume fetching operations from the leader index. + * Resume a follower. + *

+ * Resume a cross-cluster replication follower index that was paused. The + * follower index could have been paused with the pause follower API. + * Alternatively it could be paused due to replication that cannot be retried + * due to failures during following tasks. When this API returns, the follower + * index will resume fetching operations from the leader index. * * @see Documentation @@ -568,11 +580,13 @@ public CompletableFuture resumeFollow(ResumeFollowRequest } /** - * Resume a follower. Resume a cross-cluster replication follower index that was - * paused. The follower index could have been paused with the pause follower - * API. Alternatively it could be paused due to replication that cannot be - * retried due to failures during following tasks. When this API returns, the - * follower index will resume fetching operations from the leader index. + * Resume a follower. + *

+ * Resume a cross-cluster replication follower index that was paused. The + * follower index could have been paused with the pause follower API. + * Alternatively it could be paused due to replication that cannot be retried + * due to failures during following tasks. When this API returns, the follower + * index will resume fetching operations from the leader index. * * @param fn * a function that initializes a builder to create the diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/ElasticsearchCcrClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/ElasticsearchCcrClient.java index 87cdd47a3d..accce4a706 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/ElasticsearchCcrClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/ElasticsearchCcrClient.java @@ -107,10 +107,12 @@ public final DeleteAutoFollowPatternResponse deleteAutoFollowPattern( // ----- Endpoint: ccr.follow /** - * Create a follower. Create a cross-cluster replication follower index that - * follows a specific leader index. When the API returns, the follower index - * exists and cross-cluster replication starts replicating operations from the - * leader index to the follower index. + * Create a follower. + *

+ * Create a cross-cluster replication follower index that follows a specific + * leader index. When the API returns, the follower index exists and + * cross-cluster replication starts replicating operations from the leader index + * to the follower index. * * @see Documentation @@ -125,10 +127,12 @@ public FollowResponse follow(FollowRequest request) throws IOException, Elastics } /** - * Create a follower. Create a cross-cluster replication follower index that - * follows a specific leader index. When the API returns, the follower index - * exists and cross-cluster replication starts replicating operations from the - * leader index to the follower index. + * Create a follower. + *

+ * Create a cross-cluster replication follower index that follows a specific + * leader index. When the API returns, the follower index exists and + * cross-cluster replication starts replicating operations from the leader index + * to the follower index. * * @param fn * a function that initializes a builder to create the @@ -229,8 +233,10 @@ public final FollowStatsResponse followStats( // ----- Endpoint: ccr.forget_follower /** - * Forget a follower. Remove the cross-cluster replication follower retention - * leases from the leader. + * Forget a follower. + *

+ * Remove the cross-cluster replication follower retention leases from the + * leader. *

* A following index takes out retention leases on its leader index. These * leases are used to increase the likelihood that the shards of the leader @@ -265,8 +271,10 @@ public ForgetFollowerResponse forgetFollower(ForgetFollowerRequest request) } /** - * Forget a follower. Remove the cross-cluster replication follower retention - * leases from the leader. + * Forget a follower. + *

+ * Remove the cross-cluster replication follower retention leases from the + * leader. *

* A following index takes out retention leases on its leader index. These * leases are used to increase the likelihood that the shards of the leader @@ -459,12 +467,13 @@ public final PauseFollowResponse pauseFollow( // ----- Endpoint: ccr.put_auto_follow_pattern /** - * Create or update auto-follow patterns. Create a collection of cross-cluster - * replication auto-follow patterns for a remote cluster. Newly created indices - * on the remote cluster that match any of the patterns are automatically - * configured as follower indices. Indices on the remote cluster that were - * created before the auto-follow pattern was created will not be auto-followed - * even if they match the pattern. + * Create or update auto-follow patterns. + *

+ * Create a collection of cross-cluster replication auto-follow patterns for a + * remote cluster. Newly created indices on the remote cluster that match any of + * the patterns are automatically configured as follower indices. Indices on the + * remote cluster that were created before the auto-follow pattern was created + * will not be auto-followed even if they match the pattern. *

* This API can also be used to update auto-follow patterns. NOTE: Follower * indices that were configured automatically before updating an auto-follow @@ -485,12 +494,13 @@ public PutAutoFollowPatternResponse putAutoFollowPattern(PutAutoFollowPatternReq } /** - * Create or update auto-follow patterns. Create a collection of cross-cluster - * replication auto-follow patterns for a remote cluster. Newly created indices - * on the remote cluster that match any of the patterns are automatically - * configured as follower indices. Indices on the remote cluster that were - * created before the auto-follow pattern was created will not be auto-followed - * even if they match the pattern. + * Create or update auto-follow patterns. + *

+ * Create a collection of cross-cluster replication auto-follow patterns for a + * remote cluster. Newly created indices on the remote cluster that match any of + * the patterns are automatically configured as follower indices. Indices on the + * remote cluster that were created before the auto-follow pattern was created + * will not be auto-followed even if they match the pattern. *

* This API can also be used to update auto-follow patterns. NOTE: Follower * indices that were configured automatically before updating an auto-follow @@ -561,11 +571,13 @@ public final ResumeAutoFollowPatternResponse resumeAutoFollowPattern( // ----- Endpoint: ccr.resume_follow /** - * Resume a follower. Resume a cross-cluster replication follower index that was - * paused. The follower index could have been paused with the pause follower - * API. Alternatively it could be paused due to replication that cannot be - * retried due to failures during following tasks. When this API returns, the - * follower index will resume fetching operations from the leader index. + * Resume a follower. + *

+ * Resume a cross-cluster replication follower index that was paused. The + * follower index could have been paused with the pause follower API. + * Alternatively it could be paused due to replication that cannot be retried + * due to failures during following tasks. When this API returns, the follower + * index will resume fetching operations from the leader index. * * @see Documentation @@ -580,11 +592,13 @@ public ResumeFollowResponse resumeFollow(ResumeFollowRequest request) throws IOE } /** - * Resume a follower. Resume a cross-cluster replication follower index that was - * paused. The follower index could have been paused with the pause follower - * API. Alternatively it could be paused due to replication that cannot be - * retried due to failures during following tasks. When this API returns, the - * follower index will resume fetching operations from the leader index. + * Resume a follower. + *

+ * Resume a cross-cluster replication follower index that was paused. The + * follower index could have been paused with the pause follower API. + * Alternatively it could be paused due to replication that cannot be retried + * due to failures during following tasks. When this API returns, the follower + * index will resume fetching operations from the leader index. * * @param fn * a function that initializes a builder to create the diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/FollowRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/FollowRequest.java index a9e968997a..55793614ec 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/FollowRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/FollowRequest.java @@ -62,10 +62,12 @@ // typedef: ccr.follow.Request /** - * Create a follower. Create a cross-cluster replication follower index that - * follows a specific leader index. When the API returns, the follower index - * exists and cross-cluster replication starts replicating operations from the - * leader index to the follower index. + * Create a follower. + *

+ * Create a cross-cluster replication follower index that follows a specific + * leader index. When the API returns, the follower index exists and + * cross-cluster replication starts replicating operations from the leader index + * to the follower index. * * @see API * specification diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/ForgetFollowerRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/ForgetFollowerRequest.java index 0881761e6d..d82c981d62 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/ForgetFollowerRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/ForgetFollowerRequest.java @@ -58,8 +58,10 @@ // typedef: ccr.forget_follower.Request /** - * Forget a follower. Remove the cross-cluster replication follower retention - * leases from the leader. + * Forget a follower. + *

+ * Remove the cross-cluster replication follower retention leases from the + * leader. *

* A following index takes out retention leases on its leader index. These * leases are used to increase the likelihood that the shards of the leader diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/PutAutoFollowPatternRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/PutAutoFollowPatternRequest.java index a98cd5d5db..26f6535c9d 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/PutAutoFollowPatternRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/PutAutoFollowPatternRequest.java @@ -61,12 +61,13 @@ // typedef: ccr.put_auto_follow_pattern.Request /** - * Create or update auto-follow patterns. Create a collection of cross-cluster - * replication auto-follow patterns for a remote cluster. Newly created indices - * on the remote cluster that match any of the patterns are automatically - * configured as follower indices. Indices on the remote cluster that were - * created before the auto-follow pattern was created will not be auto-followed - * even if they match the pattern. + * Create or update auto-follow patterns. + *

+ * Create a collection of cross-cluster replication auto-follow patterns for a + * remote cluster. Newly created indices on the remote cluster that match any of + * the patterns are automatically configured as follower indices. Indices on the + * remote cluster that were created before the auto-follow pattern was created + * will not be auto-followed even if they match the pattern. *

* This API can also be used to update auto-follow patterns. NOTE: Follower * indices that were configured automatically before updating an auto-follow diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/ResumeFollowRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/ResumeFollowRequest.java index 587e9efb82..7011f360a5 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/ResumeFollowRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/ResumeFollowRequest.java @@ -59,11 +59,13 @@ // typedef: ccr.resume_follow.Request /** - * Resume a follower. Resume a cross-cluster replication follower index that was - * paused. The follower index could have been paused with the pause follower - * API. Alternatively it could be paused due to replication that cannot be - * retried due to failures during following tasks. When this API returns, the - * follower index will resume fetching operations from the leader index. + * Resume a follower. + *

+ * Resume a cross-cluster replication follower index that was paused. The + * follower index could have been paused with the pause follower API. + * Alternatively it could be paused due to replication that cannot be retried + * due to failures during following tasks. When this API returns, the follower + * index will resume fetching operations from the leader index. * * @see API * specification diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/AllocationExplainRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/AllocationExplainRequest.java index af09356110..d2686fd4ce 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/AllocationExplainRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/AllocationExplainRequest.java @@ -60,14 +60,16 @@ // typedef: cluster.allocation_explain.Request /** - * Explain the shard allocations. Get explanations for shard allocations in the - * cluster. For unassigned shards, it provides an explanation for why the shard - * is unassigned. For assigned shards, it provides an explanation for why the - * shard is remaining on its current node and has not moved or rebalanced to - * another node. This API can be very useful when attempting to diagnose why a - * shard is unassigned or why a shard continues to remain on its current node - * when you might expect otherwise. Refer to the linked documentation for - * examples of how to troubleshoot allocation issues using this API. + * Explain the shard allocations. + *

+ * Get explanations for shard allocations in the cluster. For unassigned shards, + * it provides an explanation for why the shard is unassigned. For assigned + * shards, it provides an explanation for why the shard is remaining on its + * current node and has not moved or rebalanced to another node. This API can be + * very useful when attempting to diagnose why a shard is unassigned or why a + * shard continues to remain on its current node when you might expect + * otherwise. Refer to the linked documentation for examples of how to + * troubleshoot allocation issues using this API. * * @see API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ClusterInfoRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ClusterInfoRequest.java index e0cbc76f9a..22646ebbfa 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ClusterInfoRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ClusterInfoRequest.java @@ -58,7 +58,9 @@ // typedef: cluster.info.Request /** - * Get cluster info. Returns basic information about the cluster. + * Get cluster info. + *

+ * Returns basic information about the cluster. * * @see API * specification diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ClusterStatsRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ClusterStatsRequest.java index 0d4e38fc4d..76217bc81f 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ClusterStatsRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ClusterStatsRequest.java @@ -59,9 +59,11 @@ // typedef: cluster.stats.Request /** - * Get cluster statistics. Get basic index metrics (shard numbers, store size, - * memory usage) and information about the current nodes that form the cluster - * (number, roles, os, jvm versions, memory usage, cpu and installed plugins). + * Get cluster statistics. + *

+ * Get basic index metrics (shard numbers, store size, memory usage) and + * information about the current nodes that form the cluster (number, roles, os, + * jvm versions, memory usage, cpu and installed plugins). * * @see API * specification diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/DeleteComponentTemplateRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/DeleteComponentTemplateRequest.java index 095f694f79..2ab2efd72d 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/DeleteComponentTemplateRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/DeleteComponentTemplateRequest.java @@ -58,9 +58,10 @@ // typedef: cluster.delete_component_template.Request /** - * Delete component templates. Component templates are building blocks for - * constructing index templates that specify index mappings, settings, and - * aliases. + * Delete component templates. + *

+ * Component templates are building blocks for constructing index templates that + * specify index mappings, settings, and aliases. * * @see API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/DeleteVotingConfigExclusionsRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/DeleteVotingConfigExclusionsRequest.java index f2693fb577..3c01983203 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/DeleteVotingConfigExclusionsRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/DeleteVotingConfigExclusionsRequest.java @@ -58,8 +58,9 @@ // typedef: cluster.delete_voting_config_exclusions.Request /** - * Clear cluster voting config exclusions. Remove master-eligible nodes from the - * voting configuration exclusion list. + * Clear cluster voting config exclusions. + *

+ * Remove master-eligible nodes from the voting configuration exclusion list. * * @see API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ElasticsearchClusterAsyncClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ElasticsearchClusterAsyncClient.java index 410c61e961..dfe9b5b402 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ElasticsearchClusterAsyncClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ElasticsearchClusterAsyncClient.java @@ -71,14 +71,16 @@ public ElasticsearchClusterAsyncClient withTransportOptions(@Nullable TransportO // ----- Endpoint: cluster.allocation_explain /** - * Explain the shard allocations. Get explanations for shard allocations in the - * cluster. For unassigned shards, it provides an explanation for why the shard - * is unassigned. For assigned shards, it provides an explanation for why the - * shard is remaining on its current node and has not moved or rebalanced to - * another node. This API can be very useful when attempting to diagnose why a - * shard is unassigned or why a shard continues to remain on its current node - * when you might expect otherwise. Refer to the linked documentation for - * examples of how to troubleshoot allocation issues using this API. + * Explain the shard allocations. + *

+ * Get explanations for shard allocations in the cluster. For unassigned shards, + * it provides an explanation for why the shard is unassigned. For assigned + * shards, it provides an explanation for why the shard is remaining on its + * current node and has not moved or rebalanced to another node. This API can be + * very useful when attempting to diagnose why a shard is unassigned or why a + * shard continues to remain on its current node when you might expect + * otherwise. Refer to the linked documentation for examples of how to + * troubleshoot allocation issues using this API. * * @see Documentation @@ -93,14 +95,16 @@ public CompletableFuture allocationExplain(Allocation } /** - * Explain the shard allocations. Get explanations for shard allocations in the - * cluster. For unassigned shards, it provides an explanation for why the shard - * is unassigned. For assigned shards, it provides an explanation for why the - * shard is remaining on its current node and has not moved or rebalanced to - * another node. This API can be very useful when attempting to diagnose why a - * shard is unassigned or why a shard continues to remain on its current node - * when you might expect otherwise. Refer to the linked documentation for - * examples of how to troubleshoot allocation issues using this API. + * Explain the shard allocations. + *

+ * Get explanations for shard allocations in the cluster. For unassigned shards, + * it provides an explanation for why the shard is unassigned. For assigned + * shards, it provides an explanation for why the shard is remaining on its + * current node and has not moved or rebalanced to another node. This API can be + * very useful when attempting to diagnose why a shard is unassigned or why a + * shard continues to remain on its current node when you might expect + * otherwise. Refer to the linked documentation for examples of how to + * troubleshoot allocation issues using this API. * * @param fn * a function that initializes a builder to create the @@ -116,14 +120,16 @@ public final CompletableFuture allocationExplain( } /** - * Explain the shard allocations. Get explanations for shard allocations in the - * cluster. For unassigned shards, it provides an explanation for why the shard - * is unassigned. For assigned shards, it provides an explanation for why the - * shard is remaining on its current node and has not moved or rebalanced to - * another node. This API can be very useful when attempting to diagnose why a - * shard is unassigned or why a shard continues to remain on its current node - * when you might expect otherwise. Refer to the linked documentation for - * examples of how to troubleshoot allocation issues using this API. + * Explain the shard allocations. + *

+ * Get explanations for shard allocations in the cluster. For unassigned shards, + * it provides an explanation for why the shard is unassigned. For assigned + * shards, it provides an explanation for why the shard is remaining on its + * current node and has not moved or rebalanced to another node. This API can be + * very useful when attempting to diagnose why a shard is unassigned or why a + * shard continues to remain on its current node when you might expect + * otherwise. Refer to the linked documentation for examples of how to + * troubleshoot allocation issues using this API. * * @see Documentation @@ -138,9 +144,10 @@ public CompletableFuture allocationExplain() { // ----- Endpoint: cluster.delete_component_template /** - * Delete component templates. Component templates are building blocks for - * constructing index templates that specify index mappings, settings, and - * aliases. + * Delete component templates. + *

+ * Component templates are building blocks for constructing index templates that + * specify index mappings, settings, and aliases. * * @see Documentation @@ -156,9 +163,10 @@ public CompletableFuture deleteComponentTemplat } /** - * Delete component templates. Component templates are building blocks for - * constructing index templates that specify index mappings, settings, and - * aliases. + * Delete component templates. + *

+ * Component templates are building blocks for constructing index templates that + * specify index mappings, settings, and aliases. * * @param fn * a function that initializes a builder to create the @@ -176,8 +184,9 @@ public final CompletableFuture deleteComponentT // ----- Endpoint: cluster.delete_voting_config_exclusions /** - * Clear cluster voting config exclusions. Remove master-eligible nodes from the - * voting configuration exclusion list. + * Clear cluster voting config exclusions. + *

+ * Remove master-eligible nodes from the voting configuration exclusion list. * * @see Documentation @@ -193,8 +202,9 @@ public CompletableFuture deleteVotingConfigExclusions( } /** - * Clear cluster voting config exclusions. Remove master-eligible nodes from the - * voting configuration exclusion list. + * Clear cluster voting config exclusions. + *

+ * Remove master-eligible nodes from the voting configuration exclusion list. * * @param fn * a function that initializes a builder to create the @@ -210,8 +220,9 @@ public final CompletableFuture deleteVotingConfigExclusions( } /** - * Clear cluster voting config exclusions. Remove master-eligible nodes from the - * voting configuration exclusion list. + * Clear cluster voting config exclusions. + *

+ * Remove master-eligible nodes from the voting configuration exclusion list. * * @see Documentation @@ -226,8 +237,9 @@ public CompletableFuture deleteVotingConfigExclusions() { // ----- Endpoint: cluster.exists_component_template /** - * Check component templates. Returns information about whether a particular - * component template exists. + * Check component templates. + *

+ * Returns information about whether a particular component template exists. * * @see Documentation @@ -242,8 +254,9 @@ public CompletableFuture existsComponentTemplate(ExistsComponen } /** - * Check component templates. Returns information about whether a particular - * component template exists. + * Check component templates. + *

+ * Returns information about whether a particular component template exists. * * @param fn * a function that initializes a builder to create the @@ -261,7 +274,9 @@ public final CompletableFuture existsComponentTemplate( // ----- Endpoint: cluster.get_component_template /** - * Get component templates. Get information about component templates. + * Get component templates. + *

+ * Get information about component templates. * * @see Documentation @@ -276,7 +291,9 @@ public CompletableFuture getComponentTemplate(GetC } /** - * Get component templates. Get information about component templates. + * Get component templates. + *

+ * Get information about component templates. * * @param fn * a function that initializes a builder to create the @@ -292,7 +309,9 @@ public final CompletableFuture getComponentTemplat } /** - * Get component templates. Get information about component templates. + * Get component templates. + *

+ * Get information about component templates. * * @see Documentation @@ -447,7 +466,9 @@ public CompletableFuture health() { // ----- Endpoint: cluster.info /** - * Get cluster info. Returns basic information about the cluster. + * Get cluster info. + *

+ * Returns basic information about the cluster. * * @see Documentation @@ -462,7 +483,9 @@ public CompletableFuture info(ClusterInfoRequest request) { } /** - * Get cluster info. Returns basic information about the cluster. + * Get cluster info. + *

+ * Returns basic information about the cluster. * * @param fn * a function that initializes a builder to create the @@ -480,9 +503,10 @@ public final CompletableFuture info( // ----- Endpoint: cluster.pending_tasks /** - * Get the pending cluster tasks. Get information about cluster-level changes - * (such as create index, update mapping, allocate or fail shard) that have not - * yet taken effect. + * Get the pending cluster tasks. + *

+ * Get information about cluster-level changes (such as create index, update + * mapping, allocate or fail shard) that have not yet taken effect. *

* NOTE: This API returns a list of any pending updates to the cluster state. * These are distinct from the tasks reported by the task management API which @@ -504,9 +528,10 @@ public CompletableFuture pendingTasks(PendingTasksRequest } /** - * Get the pending cluster tasks. Get information about cluster-level changes - * (such as create index, update mapping, allocate or fail shard) that have not - * yet taken effect. + * Get the pending cluster tasks. + *

+ * Get information about cluster-level changes (such as create index, update + * mapping, allocate or fail shard) that have not yet taken effect. *

* NOTE: This API returns a list of any pending updates to the cluster state. * These are distinct from the tasks reported by the task management API which @@ -529,9 +554,10 @@ public final CompletableFuture pendingTasks( } /** - * Get the pending cluster tasks. Get information about cluster-level changes - * (such as create index, update mapping, allocate or fail shard) that have not - * yet taken effect. + * Get the pending cluster tasks. + *

+ * Get information about cluster-level changes (such as create index, update + * mapping, allocate or fail shard) that have not yet taken effect. *

* NOTE: This API returns a list of any pending updates to the cluster state. * These are distinct from the tasks reported by the task management API which @@ -553,16 +579,17 @@ public CompletableFuture pendingTasks() { // ----- Endpoint: cluster.post_voting_config_exclusions /** - * Update voting configuration exclusions. Update the cluster voting config - * exclusions by node IDs or node names. By default, if there are more than - * three master-eligible nodes in the cluster and you remove fewer than half of - * the master-eligible nodes in the cluster at once, the voting configuration - * automatically shrinks. If you want to shrink the voting configuration to - * contain fewer than three nodes or to remove half or more of the - * master-eligible nodes in the cluster at once, use this API to remove - * departing nodes from the voting configuration manually. The API adds an entry - * for each specified node to the cluster’s voting configuration exclusions - * list. It then waits until the cluster has reconfigured its voting + * Update voting configuration exclusions. + *

+ * Update the cluster voting config exclusions by node IDs or node names. By + * default, if there are more than three master-eligible nodes in the cluster + * and you remove fewer than half of the master-eligible nodes in the cluster at + * once, the voting configuration automatically shrinks. If you want to shrink + * the voting configuration to contain fewer than three nodes or to remove half + * or more of the master-eligible nodes in the cluster at once, use this API to + * remove departing nodes from the voting configuration manually. The API adds + * an entry for each specified node to the cluster’s voting configuration + * exclusions list. It then waits until the cluster has reconfigured its voting * configuration to exclude the specified nodes. *

* Clusters should have no voting configuration exclusions in normal operation. @@ -603,16 +630,17 @@ public CompletableFuture postVotingConfigExclusions(PostVotingC } /** - * Update voting configuration exclusions. Update the cluster voting config - * exclusions by node IDs or node names. By default, if there are more than - * three master-eligible nodes in the cluster and you remove fewer than half of - * the master-eligible nodes in the cluster at once, the voting configuration - * automatically shrinks. If you want to shrink the voting configuration to - * contain fewer than three nodes or to remove half or more of the - * master-eligible nodes in the cluster at once, use this API to remove - * departing nodes from the voting configuration manually. The API adds an entry - * for each specified node to the cluster’s voting configuration exclusions - * list. It then waits until the cluster has reconfigured its voting + * Update voting configuration exclusions. + *

+ * Update the cluster voting config exclusions by node IDs or node names. By + * default, if there are more than three master-eligible nodes in the cluster + * and you remove fewer than half of the master-eligible nodes in the cluster at + * once, the voting configuration automatically shrinks. If you want to shrink + * the voting configuration to contain fewer than three nodes or to remove half + * or more of the master-eligible nodes in the cluster at once, use this API to + * remove departing nodes from the voting configuration manually. The API adds + * an entry for each specified node to the cluster’s voting configuration + * exclusions list. It then waits until the cluster has reconfigured its voting * configuration to exclude the specified nodes. *

* Clusters should have no voting configuration exclusions in normal operation. @@ -654,16 +682,17 @@ public final CompletableFuture postVotingConfigExclusions( } /** - * Update voting configuration exclusions. Update the cluster voting config - * exclusions by node IDs or node names. By default, if there are more than - * three master-eligible nodes in the cluster and you remove fewer than half of - * the master-eligible nodes in the cluster at once, the voting configuration - * automatically shrinks. If you want to shrink the voting configuration to - * contain fewer than three nodes or to remove half or more of the - * master-eligible nodes in the cluster at once, use this API to remove - * departing nodes from the voting configuration manually. The API adds an entry - * for each specified node to the cluster’s voting configuration exclusions - * list. It then waits until the cluster has reconfigured its voting + * Update voting configuration exclusions. + *

+ * Update the cluster voting config exclusions by node IDs or node names. By + * default, if there are more than three master-eligible nodes in the cluster + * and you remove fewer than half of the master-eligible nodes in the cluster at + * once, the voting configuration automatically shrinks. If you want to shrink + * the voting configuration to contain fewer than three nodes or to remove half + * or more of the master-eligible nodes in the cluster at once, use this API to + * remove departing nodes from the voting configuration manually. The API adds + * an entry for each specified node to the cluster’s voting configuration + * exclusions list. It then waits until the cluster has reconfigured its voting * configuration to exclude the specified nodes. *

* Clusters should have no voting configuration exclusions in normal operation. @@ -704,9 +733,10 @@ public CompletableFuture postVotingConfigExclusions() { // ----- Endpoint: cluster.put_component_template /** - * Create or update a component template. Component templates are building - * blocks for constructing index templates that specify index mappings, - * settings, and aliases. + * Create or update a component template. + *

+ * Component templates are building blocks for constructing index templates that + * specify index mappings, settings, and aliases. *

* An index template can be composed of multiple component templates. To use a * component template, specify it in an index template’s @@ -745,9 +775,10 @@ public CompletableFuture putComponentTemplate(PutC } /** - * Create or update a component template. Component templates are building - * blocks for constructing index templates that specify index mappings, - * settings, and aliases. + * Create or update a component template. + *

+ * Component templates are building blocks for constructing index templates that + * specify index mappings, settings, and aliases. *

* An index template can be composed of multiple component templates. To use a * component template, specify it in an index template’s @@ -949,10 +980,12 @@ public CompletableFuture remoteInfo() { // ----- Endpoint: cluster.reroute /** - * Reroute the cluster. Manually change the allocation of individual shards in - * the cluster. For example, a shard can be moved from one node to another - * explicitly, an allocation can be canceled, and an unassigned shard can be - * explicitly allocated to a specific node. + * Reroute the cluster. + *

+ * Manually change the allocation of individual shards in the cluster. For + * example, a shard can be moved from one node to another explicitly, an + * allocation can be canceled, and an unassigned shard can be explicitly + * allocated to a specific node. *

* It is important to note that after processing any reroute commands * Elasticsearch will perform rebalancing as normal (respecting the values of @@ -990,10 +1023,12 @@ public CompletableFuture reroute(RerouteRequest request) { } /** - * Reroute the cluster. Manually change the allocation of individual shards in - * the cluster. For example, a shard can be moved from one node to another - * explicitly, an allocation can be canceled, and an unassigned shard can be - * explicitly allocated to a specific node. + * Reroute the cluster. + *

+ * Manually change the allocation of individual shards in the cluster. For + * example, a shard can be moved from one node to another explicitly, an + * allocation can be canceled, and an unassigned shard can be explicitly + * allocated to a specific node. *

* It is important to note that after processing any reroute commands * Elasticsearch will perform rebalancing as normal (respecting the values of @@ -1032,10 +1067,12 @@ public final CompletableFuture reroute( } /** - * Reroute the cluster. Manually change the allocation of individual shards in - * the cluster. For example, a shard can be moved from one node to another - * explicitly, an allocation can be canceled, and an unassigned shard can be - * explicitly allocated to a specific node. + * Reroute the cluster. + *

+ * Manually change the allocation of individual shards in the cluster. For + * example, a shard can be moved from one node to another explicitly, an + * allocation can be canceled, and an unassigned shard can be explicitly + * allocated to a specific node. *

* It is important to note that after processing any reroute commands * Elasticsearch will perform rebalancing as normal (respecting the values of @@ -1073,8 +1110,9 @@ public CompletableFuture reroute() { // ----- Endpoint: cluster.state /** - * Get the cluster state. Get comprehensive information about the state of the - * cluster. + * Get the cluster state. + *

+ * Get comprehensive information about the state of the cluster. *

* The cluster state is an internal data structure which keeps track of a * variety of information needed by every node, including the identity and @@ -1117,8 +1155,9 @@ public CompletableFuture state(StateRequest request) { } /** - * Get the cluster state. Get comprehensive information about the state of the - * cluster. + * Get the cluster state. + *

+ * Get comprehensive information about the state of the cluster. *

* The cluster state is an internal data structure which keeps track of a * variety of information needed by every node, including the identity and @@ -1162,8 +1201,9 @@ public final CompletableFuture state( } /** - * Get the cluster state. Get comprehensive information about the state of the - * cluster. + * Get the cluster state. + *

+ * Get comprehensive information about the state of the cluster. *

* The cluster state is an internal data structure which keeps track of a * variety of information needed by every node, including the identity and @@ -1206,9 +1246,11 @@ public CompletableFuture state() { // ----- Endpoint: cluster.stats /** - * Get cluster statistics. Get basic index metrics (shard numbers, store size, - * memory usage) and information about the current nodes that form the cluster - * (number, roles, os, jvm versions, memory usage, cpu and installed plugins). + * Get cluster statistics. + *

+ * Get basic index metrics (shard numbers, store size, memory usage) and + * information about the current nodes that form the cluster (number, roles, os, + * jvm versions, memory usage, cpu and installed plugins). * * @see Documentation @@ -1223,9 +1265,11 @@ public CompletableFuture stats(ClusterStatsRequest request } /** - * Get cluster statistics. Get basic index metrics (shard numbers, store size, - * memory usage) and information about the current nodes that form the cluster - * (number, roles, os, jvm versions, memory usage, cpu and installed plugins). + * Get cluster statistics. + *

+ * Get basic index metrics (shard numbers, store size, memory usage) and + * information about the current nodes that form the cluster (number, roles, os, + * jvm versions, memory usage, cpu and installed plugins). * * @param fn * a function that initializes a builder to create the @@ -1241,9 +1285,11 @@ public final CompletableFuture stats( } /** - * Get cluster statistics. Get basic index metrics (shard numbers, store size, - * memory usage) and information about the current nodes that form the cluster - * (number, roles, os, jvm versions, memory usage, cpu and installed plugins). + * Get cluster statistics. + *

+ * Get basic index metrics (shard numbers, store size, memory usage) and + * information about the current nodes that form the cluster (number, roles, os, + * jvm versions, memory usage, cpu and installed plugins). * * @see Documentation diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ElasticsearchClusterClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ElasticsearchClusterClient.java index 2083dcc456..425d26aef7 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ElasticsearchClusterClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ElasticsearchClusterClient.java @@ -69,14 +69,16 @@ public ElasticsearchClusterClient withTransportOptions(@Nullable TransportOption // ----- Endpoint: cluster.allocation_explain /** - * Explain the shard allocations. Get explanations for shard allocations in the - * cluster. For unassigned shards, it provides an explanation for why the shard - * is unassigned. For assigned shards, it provides an explanation for why the - * shard is remaining on its current node and has not moved or rebalanced to - * another node. This API can be very useful when attempting to diagnose why a - * shard is unassigned or why a shard continues to remain on its current node - * when you might expect otherwise. Refer to the linked documentation for - * examples of how to troubleshoot allocation issues using this API. + * Explain the shard allocations. + *

+ * Get explanations for shard allocations in the cluster. For unassigned shards, + * it provides an explanation for why the shard is unassigned. For assigned + * shards, it provides an explanation for why the shard is remaining on its + * current node and has not moved or rebalanced to another node. This API can be + * very useful when attempting to diagnose why a shard is unassigned or why a + * shard continues to remain on its current node when you might expect + * otherwise. Refer to the linked documentation for examples of how to + * troubleshoot allocation issues using this API. * * @see Documentation @@ -92,14 +94,16 @@ public AllocationExplainResponse allocationExplain(AllocationExplainRequest requ } /** - * Explain the shard allocations. Get explanations for shard allocations in the - * cluster. For unassigned shards, it provides an explanation for why the shard - * is unassigned. For assigned shards, it provides an explanation for why the - * shard is remaining on its current node and has not moved or rebalanced to - * another node. This API can be very useful when attempting to diagnose why a - * shard is unassigned or why a shard continues to remain on its current node - * when you might expect otherwise. Refer to the linked documentation for - * examples of how to troubleshoot allocation issues using this API. + * Explain the shard allocations. + *

+ * Get explanations for shard allocations in the cluster. For unassigned shards, + * it provides an explanation for why the shard is unassigned. For assigned + * shards, it provides an explanation for why the shard is remaining on its + * current node and has not moved or rebalanced to another node. This API can be + * very useful when attempting to diagnose why a shard is unassigned or why a + * shard continues to remain on its current node when you might expect + * otherwise. Refer to the linked documentation for examples of how to + * troubleshoot allocation issues using this API. * * @param fn * a function that initializes a builder to create the @@ -116,14 +120,16 @@ public final AllocationExplainResponse allocationExplain( } /** - * Explain the shard allocations. Get explanations for shard allocations in the - * cluster. For unassigned shards, it provides an explanation for why the shard - * is unassigned. For assigned shards, it provides an explanation for why the - * shard is remaining on its current node and has not moved or rebalanced to - * another node. This API can be very useful when attempting to diagnose why a - * shard is unassigned or why a shard continues to remain on its current node - * when you might expect otherwise. Refer to the linked documentation for - * examples of how to troubleshoot allocation issues using this API. + * Explain the shard allocations. + *

+ * Get explanations for shard allocations in the cluster. For unassigned shards, + * it provides an explanation for why the shard is unassigned. For assigned + * shards, it provides an explanation for why the shard is remaining on its + * current node and has not moved or rebalanced to another node. This API can be + * very useful when attempting to diagnose why a shard is unassigned or why a + * shard continues to remain on its current node when you might expect + * otherwise. Refer to the linked documentation for examples of how to + * troubleshoot allocation issues using this API. * * @see Documentation @@ -138,9 +144,10 @@ public AllocationExplainResponse allocationExplain() throws IOException, Elastic // ----- Endpoint: cluster.delete_component_template /** - * Delete component templates. Component templates are building blocks for - * constructing index templates that specify index mappings, settings, and - * aliases. + * Delete component templates. + *

+ * Component templates are building blocks for constructing index templates that + * specify index mappings, settings, and aliases. * * @see Documentation @@ -156,9 +163,10 @@ public DeleteComponentTemplateResponse deleteComponentTemplate(DeleteComponentTe } /** - * Delete component templates. Component templates are building blocks for - * constructing index templates that specify index mappings, settings, and - * aliases. + * Delete component templates. + *

+ * Component templates are building blocks for constructing index templates that + * specify index mappings, settings, and aliases. * * @param fn * a function that initializes a builder to create the @@ -177,8 +185,9 @@ public final DeleteComponentTemplateResponse deleteComponentTemplate( // ----- Endpoint: cluster.delete_voting_config_exclusions /** - * Clear cluster voting config exclusions. Remove master-eligible nodes from the - * voting configuration exclusion list. + * Clear cluster voting config exclusions. + *

+ * Remove master-eligible nodes from the voting configuration exclusion list. * * @see Documentation @@ -194,8 +203,9 @@ public BooleanResponse deleteVotingConfigExclusions(DeleteVotingConfigExclusions } /** - * Clear cluster voting config exclusions. Remove master-eligible nodes from the - * voting configuration exclusion list. + * Clear cluster voting config exclusions. + *

+ * Remove master-eligible nodes from the voting configuration exclusion list. * * @param fn * a function that initializes a builder to create the @@ -212,8 +222,9 @@ public final BooleanResponse deleteVotingConfigExclusions( } /** - * Clear cluster voting config exclusions. Remove master-eligible nodes from the - * voting configuration exclusion list. + * Clear cluster voting config exclusions. + *

+ * Remove master-eligible nodes from the voting configuration exclusion list. * * @see Documentation @@ -228,8 +239,9 @@ public BooleanResponse deleteVotingConfigExclusions() throws IOException, Elasti // ----- Endpoint: cluster.exists_component_template /** - * Check component templates. Returns information about whether a particular - * component template exists. + * Check component templates. + *

+ * Returns information about whether a particular component template exists. * * @see Documentation @@ -245,8 +257,9 @@ public BooleanResponse existsComponentTemplate(ExistsComponentTemplateRequest re } /** - * Check component templates. Returns information about whether a particular - * component template exists. + * Check component templates. + *

+ * Returns information about whether a particular component template exists. * * @param fn * a function that initializes a builder to create the @@ -265,7 +278,9 @@ public final BooleanResponse existsComponentTemplate( // ----- Endpoint: cluster.get_component_template /** - * Get component templates. Get information about component templates. + * Get component templates. + *

+ * Get information about component templates. * * @see Documentation @@ -281,7 +296,9 @@ public GetComponentTemplateResponse getComponentTemplate(GetComponentTemplateReq } /** - * Get component templates. Get information about component templates. + * Get component templates. + *

+ * Get information about component templates. * * @param fn * a function that initializes a builder to create the @@ -298,7 +315,9 @@ public final GetComponentTemplateResponse getComponentTemplate( } /** - * Get component templates. Get information about component templates. + * Get component templates. + *

+ * Get information about component templates. * * @see Documentation @@ -455,7 +474,9 @@ public HealthResponse health() throws IOException, ElasticsearchException { // ----- Endpoint: cluster.info /** - * Get cluster info. Returns basic information about the cluster. + * Get cluster info. + *

+ * Returns basic information about the cluster. * * @see Documentation @@ -470,7 +491,9 @@ public ClusterInfoResponse info(ClusterInfoRequest request) throws IOException, } /** - * Get cluster info. Returns basic information about the cluster. + * Get cluster info. + *

+ * Returns basic information about the cluster. * * @param fn * a function that initializes a builder to create the @@ -488,9 +511,10 @@ public final ClusterInfoResponse info(Function + * Get information about cluster-level changes (such as create index, update + * mapping, allocate or fail shard) that have not yet taken effect. *

* NOTE: This API returns a list of any pending updates to the cluster state. * These are distinct from the tasks reported by the task management API which @@ -512,9 +536,10 @@ public PendingTasksResponse pendingTasks(PendingTasksRequest request) throws IOE } /** - * Get the pending cluster tasks. Get information about cluster-level changes - * (such as create index, update mapping, allocate or fail shard) that have not - * yet taken effect. + * Get the pending cluster tasks. + *

+ * Get information about cluster-level changes (such as create index, update + * mapping, allocate or fail shard) that have not yet taken effect. *

* NOTE: This API returns a list of any pending updates to the cluster state. * These are distinct from the tasks reported by the task management API which @@ -538,9 +563,10 @@ public final PendingTasksResponse pendingTasks( } /** - * Get the pending cluster tasks. Get information about cluster-level changes - * (such as create index, update mapping, allocate or fail shard) that have not - * yet taken effect. + * Get the pending cluster tasks. + *

+ * Get information about cluster-level changes (such as create index, update + * mapping, allocate or fail shard) that have not yet taken effect. *

* NOTE: This API returns a list of any pending updates to the cluster state. * These are distinct from the tasks reported by the task management API which @@ -562,16 +588,17 @@ public PendingTasksResponse pendingTasks() throws IOException, ElasticsearchExce // ----- Endpoint: cluster.post_voting_config_exclusions /** - * Update voting configuration exclusions. Update the cluster voting config - * exclusions by node IDs or node names. By default, if there are more than - * three master-eligible nodes in the cluster and you remove fewer than half of - * the master-eligible nodes in the cluster at once, the voting configuration - * automatically shrinks. If you want to shrink the voting configuration to - * contain fewer than three nodes or to remove half or more of the - * master-eligible nodes in the cluster at once, use this API to remove - * departing nodes from the voting configuration manually. The API adds an entry - * for each specified node to the cluster’s voting configuration exclusions - * list. It then waits until the cluster has reconfigured its voting + * Update voting configuration exclusions. + *

+ * Update the cluster voting config exclusions by node IDs or node names. By + * default, if there are more than three master-eligible nodes in the cluster + * and you remove fewer than half of the master-eligible nodes in the cluster at + * once, the voting configuration automatically shrinks. If you want to shrink + * the voting configuration to contain fewer than three nodes or to remove half + * or more of the master-eligible nodes in the cluster at once, use this API to + * remove departing nodes from the voting configuration manually. The API adds + * an entry for each specified node to the cluster’s voting configuration + * exclusions list. It then waits until the cluster has reconfigured its voting * configuration to exclude the specified nodes. *

* Clusters should have no voting configuration exclusions in normal operation. @@ -613,16 +640,17 @@ public BooleanResponse postVotingConfigExclusions(PostVotingConfigExclusionsRequ } /** - * Update voting configuration exclusions. Update the cluster voting config - * exclusions by node IDs or node names. By default, if there are more than - * three master-eligible nodes in the cluster and you remove fewer than half of - * the master-eligible nodes in the cluster at once, the voting configuration - * automatically shrinks. If you want to shrink the voting configuration to - * contain fewer than three nodes or to remove half or more of the - * master-eligible nodes in the cluster at once, use this API to remove - * departing nodes from the voting configuration manually. The API adds an entry - * for each specified node to the cluster’s voting configuration exclusions - * list. It then waits until the cluster has reconfigured its voting + * Update voting configuration exclusions. + *

+ * Update the cluster voting config exclusions by node IDs or node names. By + * default, if there are more than three master-eligible nodes in the cluster + * and you remove fewer than half of the master-eligible nodes in the cluster at + * once, the voting configuration automatically shrinks. If you want to shrink + * the voting configuration to contain fewer than three nodes or to remove half + * or more of the master-eligible nodes in the cluster at once, use this API to + * remove departing nodes from the voting configuration manually. The API adds + * an entry for each specified node to the cluster’s voting configuration + * exclusions list. It then waits until the cluster has reconfigured its voting * configuration to exclude the specified nodes. *

* Clusters should have no voting configuration exclusions in normal operation. @@ -665,16 +693,17 @@ public final BooleanResponse postVotingConfigExclusions( } /** - * Update voting configuration exclusions. Update the cluster voting config - * exclusions by node IDs or node names. By default, if there are more than - * three master-eligible nodes in the cluster and you remove fewer than half of - * the master-eligible nodes in the cluster at once, the voting configuration - * automatically shrinks. If you want to shrink the voting configuration to - * contain fewer than three nodes or to remove half or more of the - * master-eligible nodes in the cluster at once, use this API to remove - * departing nodes from the voting configuration manually. The API adds an entry - * for each specified node to the cluster’s voting configuration exclusions - * list. It then waits until the cluster has reconfigured its voting + * Update voting configuration exclusions. + *

+ * Update the cluster voting config exclusions by node IDs or node names. By + * default, if there are more than three master-eligible nodes in the cluster + * and you remove fewer than half of the master-eligible nodes in the cluster at + * once, the voting configuration automatically shrinks. If you want to shrink + * the voting configuration to contain fewer than three nodes or to remove half + * or more of the master-eligible nodes in the cluster at once, use this API to + * remove departing nodes from the voting configuration manually. The API adds + * an entry for each specified node to the cluster’s voting configuration + * exclusions list. It then waits until the cluster has reconfigured its voting * configuration to exclude the specified nodes. *

* Clusters should have no voting configuration exclusions in normal operation. @@ -715,9 +744,10 @@ public BooleanResponse postVotingConfigExclusions() throws IOException, Elastics // ----- Endpoint: cluster.put_component_template /** - * Create or update a component template. Component templates are building - * blocks for constructing index templates that specify index mappings, - * settings, and aliases. + * Create or update a component template. + *

+ * Component templates are building blocks for constructing index templates that + * specify index mappings, settings, and aliases. *

* An index template can be composed of multiple component templates. To use a * component template, specify it in an index template’s @@ -757,9 +787,10 @@ public PutComponentTemplateResponse putComponentTemplate(PutComponentTemplateReq } /** - * Create or update a component template. Component templates are building - * blocks for constructing index templates that specify index mappings, - * settings, and aliases. + * Create or update a component template. + *

+ * Component templates are building blocks for constructing index templates that + * specify index mappings, settings, and aliases. *

* An index template can be composed of multiple component templates. To use a * component template, specify it in an index template’s @@ -964,10 +995,12 @@ public RemoteInfoResponse remoteInfo() throws IOException, ElasticsearchExceptio // ----- Endpoint: cluster.reroute /** - * Reroute the cluster. Manually change the allocation of individual shards in - * the cluster. For example, a shard can be moved from one node to another - * explicitly, an allocation can be canceled, and an unassigned shard can be - * explicitly allocated to a specific node. + * Reroute the cluster. + *

+ * Manually change the allocation of individual shards in the cluster. For + * example, a shard can be moved from one node to another explicitly, an + * allocation can be canceled, and an unassigned shard can be explicitly + * allocated to a specific node. *

* It is important to note that after processing any reroute commands * Elasticsearch will perform rebalancing as normal (respecting the values of @@ -1005,10 +1038,12 @@ public RerouteResponse reroute(RerouteRequest request) throws IOException, Elast } /** - * Reroute the cluster. Manually change the allocation of individual shards in - * the cluster. For example, a shard can be moved from one node to another - * explicitly, an allocation can be canceled, and an unassigned shard can be - * explicitly allocated to a specific node. + * Reroute the cluster. + *

+ * Manually change the allocation of individual shards in the cluster. For + * example, a shard can be moved from one node to another explicitly, an + * allocation can be canceled, and an unassigned shard can be explicitly + * allocated to a specific node. *

* It is important to note that after processing any reroute commands * Elasticsearch will perform rebalancing as normal (respecting the values of @@ -1047,10 +1082,12 @@ public final RerouteResponse reroute(Function + * Manually change the allocation of individual shards in the cluster. For + * example, a shard can be moved from one node to another explicitly, an + * allocation can be canceled, and an unassigned shard can be explicitly + * allocated to a specific node. *

* It is important to note that after processing any reroute commands * Elasticsearch will perform rebalancing as normal (respecting the values of @@ -1088,8 +1125,9 @@ public RerouteResponse reroute() throws IOException, ElasticsearchException { // ----- Endpoint: cluster.state /** - * Get the cluster state. Get comprehensive information about the state of the - * cluster. + * Get the cluster state. + *

+ * Get comprehensive information about the state of the cluster. *

* The cluster state is an internal data structure which keeps track of a * variety of information needed by every node, including the identity and @@ -1132,8 +1170,9 @@ public StateResponse state(StateRequest request) throws IOException, Elasticsear } /** - * Get the cluster state. Get comprehensive information about the state of the - * cluster. + * Get the cluster state. + *

+ * Get comprehensive information about the state of the cluster. *

* The cluster state is an internal data structure which keeps track of a * variety of information needed by every node, including the identity and @@ -1177,8 +1216,9 @@ public final StateResponse state(Function + * Get comprehensive information about the state of the cluster. *

* The cluster state is an internal data structure which keeps track of a * variety of information needed by every node, including the identity and @@ -1221,9 +1261,11 @@ public StateResponse state() throws IOException, ElasticsearchException { // ----- Endpoint: cluster.stats /** - * Get cluster statistics. Get basic index metrics (shard numbers, store size, - * memory usage) and information about the current nodes that form the cluster - * (number, roles, os, jvm versions, memory usage, cpu and installed plugins). + * Get cluster statistics. + *

+ * Get basic index metrics (shard numbers, store size, memory usage) and + * information about the current nodes that form the cluster (number, roles, os, + * jvm versions, memory usage, cpu and installed plugins). * * @see Documentation @@ -1238,9 +1280,11 @@ public ClusterStatsResponse stats(ClusterStatsRequest request) throws IOExceptio } /** - * Get cluster statistics. Get basic index metrics (shard numbers, store size, - * memory usage) and information about the current nodes that form the cluster - * (number, roles, os, jvm versions, memory usage, cpu and installed plugins). + * Get cluster statistics. + *

+ * Get basic index metrics (shard numbers, store size, memory usage) and + * information about the current nodes that form the cluster (number, roles, os, + * jvm versions, memory usage, cpu and installed plugins). * * @param fn * a function that initializes a builder to create the @@ -1257,9 +1301,11 @@ public final ClusterStatsResponse stats( } /** - * Get cluster statistics. Get basic index metrics (shard numbers, store size, - * memory usage) and information about the current nodes that form the cluster - * (number, roles, os, jvm versions, memory usage, cpu and installed plugins). + * Get cluster statistics. + *

+ * Get basic index metrics (shard numbers, store size, memory usage) and + * information about the current nodes that form the cluster (number, roles, os, + * jvm versions, memory usage, cpu and installed plugins). * * @see Documentation diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ExistsComponentTemplateRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ExistsComponentTemplateRequest.java index 59e35effaf..af7b715d15 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ExistsComponentTemplateRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ExistsComponentTemplateRequest.java @@ -61,8 +61,9 @@ // typedef: cluster.exists_component_template.Request /** - * Check component templates. Returns information about whether a particular - * component template exists. + * Check component templates. + *

+ * Returns information about whether a particular component template exists. * * @see API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/GetComponentTemplateRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/GetComponentTemplateRequest.java index e0674420e2..4c0d2eea24 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/GetComponentTemplateRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/GetComponentTemplateRequest.java @@ -59,7 +59,9 @@ // typedef: cluster.get_component_template.Request /** - * Get component templates. Get information about component templates. + * Get component templates. + *

+ * Get information about component templates. * * @see API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/PendingTasksRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/PendingTasksRequest.java index dd3d455519..255d342d23 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/PendingTasksRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/PendingTasksRequest.java @@ -56,9 +56,10 @@ // typedef: cluster.pending_tasks.Request /** - * Get the pending cluster tasks. Get information about cluster-level changes - * (such as create index, update mapping, allocate or fail shard) that have not - * yet taken effect. + * Get the pending cluster tasks. + *

+ * Get information about cluster-level changes (such as create index, update + * mapping, allocate or fail shard) that have not yet taken effect. *

* NOTE: This API returns a list of any pending updates to the cluster state. * These are distinct from the tasks reported by the task management API which diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/PostVotingConfigExclusionsRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/PostVotingConfigExclusionsRequest.java index 66b3cd8558..48a5101956 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/PostVotingConfigExclusionsRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/PostVotingConfigExclusionsRequest.java @@ -61,16 +61,17 @@ // typedef: cluster.post_voting_config_exclusions.Request /** - * Update voting configuration exclusions. Update the cluster voting config - * exclusions by node IDs or node names. By default, if there are more than - * three master-eligible nodes in the cluster and you remove fewer than half of - * the master-eligible nodes in the cluster at once, the voting configuration - * automatically shrinks. If you want to shrink the voting configuration to - * contain fewer than three nodes or to remove half or more of the - * master-eligible nodes in the cluster at once, use this API to remove - * departing nodes from the voting configuration manually. The API adds an entry - * for each specified node to the cluster’s voting configuration exclusions - * list. It then waits until the cluster has reconfigured its voting + * Update voting configuration exclusions. + *

+ * Update the cluster voting config exclusions by node IDs or node names. By + * default, if there are more than three master-eligible nodes in the cluster + * and you remove fewer than half of the master-eligible nodes in the cluster at + * once, the voting configuration automatically shrinks. If you want to shrink + * the voting configuration to contain fewer than three nodes or to remove half + * or more of the master-eligible nodes in the cluster at once, use this API to + * remove departing nodes from the voting configuration manually. The API adds + * an entry for each specified node to the cluster’s voting configuration + * exclusions list. It then waits until the cluster has reconfigured its voting * configuration to exclude the specified nodes. *

* Clusters should have no voting configuration exclusions in normal operation. diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/PutComponentTemplateRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/PutComponentTemplateRequest.java index 049abd41af..903138e2b3 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/PutComponentTemplateRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/PutComponentTemplateRequest.java @@ -62,9 +62,10 @@ // typedef: cluster.put_component_template.Request /** - * Create or update a component template. Component templates are building - * blocks for constructing index templates that specify index mappings, - * settings, and aliases. + * Create or update a component template. + *

+ * Component templates are building blocks for constructing index templates that + * specify index mappings, settings, and aliases. *

* An index template can be composed of multiple component templates. To use a * component template, specify it in an index template’s diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/RerouteRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/RerouteRequest.java index 1f63486bff..60af316c03 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/RerouteRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/RerouteRequest.java @@ -63,10 +63,12 @@ // typedef: cluster.reroute.Request /** - * Reroute the cluster. Manually change the allocation of individual shards in - * the cluster. For example, a shard can be moved from one node to another - * explicitly, an allocation can be canceled, and an unassigned shard can be - * explicitly allocated to a specific node. + * Reroute the cluster. + *

+ * Manually change the allocation of individual shards in the cluster. For + * example, a shard can be moved from one node to another explicitly, an + * allocation can be canceled, and an unassigned shard can be explicitly + * allocated to a specific node. *

* It is important to note that after processing any reroute commands * Elasticsearch will perform rebalancing as normal (respecting the values of diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/StateRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/StateRequest.java index 1398dcd978..76dded42f6 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/StateRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/StateRequest.java @@ -61,8 +61,9 @@ // typedef: cluster.state.Request /** - * Get the cluster state. Get comprehensive information about the state of the - * cluster. + * Get the cluster state. + *

+ * Get comprehensive information about the state of the cluster. *

* The cluster state is an internal data structure which keeps track of a * variety of information needed by every node, including the identity and diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/ElasticsearchConnectorAsyncClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/ElasticsearchConnectorAsyncClient.java index df00ac3f6b..1a39655ed1 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/ElasticsearchConnectorAsyncClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/ElasticsearchConnectorAsyncClient.java @@ -391,9 +391,10 @@ public final CompletableFuture syncJobCancel( // ----- Endpoint: connector.sync_job_check_in /** - * Check in a connector sync job. Check in a connector sync job and set the - * last_seen field to the current time before updating it in the - * internal index. + * Check in a connector sync job. + *

+ * Check in a connector sync job and set the last_seen field to the + * current time before updating it in the internal index. *

* To sync data using self-managed connectors, you need to deploy the Elastic * connector service on your own infrastructure. This service runs automatically @@ -412,9 +413,10 @@ public CompletableFuture syncJobCheckIn(SyncJobCheckInRe } /** - * Check in a connector sync job. Check in a connector sync job and set the - * last_seen field to the current time before updating it in the - * internal index. + * Check in a connector sync job. + *

+ * Check in a connector sync job and set the last_seen field to the + * current time before updating it in the internal index. *

* To sync data using self-managed connectors, you need to deploy the Elastic * connector service on your own infrastructure. This service runs automatically @@ -436,10 +438,12 @@ public final CompletableFuture syncJobCheckIn( // ----- Endpoint: connector.sync_job_claim /** - * Claim a connector sync job. This action updates the job status to - * in_progress and sets the last_seen and - * started_at timestamps to the current time. Additionally, it can - * set the sync_cursor property for the sync job. + * Claim a connector sync job. + *

+ * This action updates the job status to in_progress and sets the + * last_seen and started_at timestamps to the current + * time. Additionally, it can set the sync_cursor property for the + * sync job. *

* This API is not intended for direct connector management by users. It * supports the implementation of services that utilize the connector protocol @@ -462,10 +466,12 @@ public CompletableFuture syncJobClaim(SyncJobClaimRequest } /** - * Claim a connector sync job. This action updates the job status to - * in_progress and sets the last_seen and - * started_at timestamps to the current time. Additionally, it can - * set the sync_cursor property for the sync job. + * Claim a connector sync job. + *

+ * This action updates the job status to in_progress and sets the + * last_seen and started_at timestamps to the current + * time. Additionally, it can set the sync_cursor property for the + * sync job. *

* This API is not intended for direct connector management by users. It * supports the implementation of services that utilize the connector protocol @@ -530,8 +536,10 @@ public final CompletableFuture syncJobDelete( // ----- Endpoint: connector.sync_job_error /** - * Set a connector sync job error. Set the error field for a - * connector sync job and set its status to error. + * Set a connector sync job error. + *

+ * Set the error field for a connector sync job and set its + * status to error. *

* To sync data using self-managed connectors, you need to deploy the Elastic * connector service on your own infrastructure. This service runs automatically @@ -550,8 +558,10 @@ public CompletableFuture syncJobError(SyncJobErrorRequest } /** - * Set a connector sync job error. Set the error field for a - * connector sync job and set its status to error. + * Set a connector sync job error. + *

+ * Set the error field for a connector sync job and set its + * status to error. *

* To sync data using self-managed connectors, you need to deploy the Elastic * connector service on your own infrastructure. This service runs automatically @@ -700,11 +710,13 @@ public final CompletableFuture syncJobPost( // ----- Endpoint: connector.sync_job_update_stats /** - * Set the connector sync job stats. Stats include: - * deleted_document_count, indexed_document_count, - * indexed_document_volume, and total_document_count. - * You can also update last_seen. This API is mainly used by the - * connector service for updating sync job information. + * Set the connector sync job stats. + *

+ * Stats include: deleted_document_count, + * indexed_document_count, indexed_document_volume, + * and total_document_count. You can also update + * last_seen. This API is mainly used by the connector service for + * updating sync job information. *

* To sync data using self-managed connectors, you need to deploy the Elastic * connector service on your own infrastructure. This service runs automatically @@ -723,11 +735,13 @@ public CompletableFuture syncJobUpdateStats(SyncJobU } /** - * Set the connector sync job stats. Stats include: - * deleted_document_count, indexed_document_count, - * indexed_document_volume, and total_document_count. - * You can also update last_seen. This API is mainly used by the - * connector service for updating sync job information. + * Set the connector sync job stats. + *

+ * Stats include: deleted_document_count, + * indexed_document_count, indexed_document_volume, + * and total_document_count. You can also update + * last_seen. This API is mainly used by the connector service for + * updating sync job information. *

* To sync data using self-managed connectors, you need to deploy the Elastic * connector service on your own infrastructure. This service runs automatically @@ -910,9 +924,10 @@ public final CompletableFuture updateError( // ----- Endpoint: connector.update_features /** - * Update the connector features. Update the connector features in the connector - * document. This API can be used to control the following aspects of a - * connector: + * Update the connector features. + *

+ * Update the connector features in the connector document. This API can be used + * to control the following aspects of a connector: *