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:
@@ -483,6 +484,8 @@ public ElasticsearchXpackAsyncClient xpack() {
* Search::Elasticsearch::Client::5_0::Scroll
*
elasticsearch.helpers.*client.helpers.*co.elastic.clients.elasticsearch._helpers.bulk.BulkIngesterBulkAllObservableElasticsearch::Helpers::BulkHelperindex,
- * 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:
@@ -662,6 +666,8 @@ public CompletableFuture
+ * Perform multiple
* If the Elasticsearch security features are enabled, you must have the
* following index privileges for the target data stream, index, or index alias:
@@ -841,6 +848,8 @@ public final CompletableFuture
+ * Clear the search context and results for a scrolling search.
*
* @see Documentation
@@ -936,8 +946,9 @@ public CompletableFuture
+ * Clear the search context and results for a scrolling search.
*
* @param fn
* a function that initializes a builder to create the
@@ -953,8 +964,9 @@ public final CompletableFuture
+ * Clear the search context and results for a scrolling search.
*
* @see Documentation
@@ -969,12 +981,14 @@ public CompletableFuture
+ * A point in time must be opened explicitly before being used in search
+ * requests. The
+ * A point in time must be opened explicitly before being used in search
+ * requests. The
+ * 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
@@ -1039,7 +1057,9 @@ public CompletableFuture
+ * 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
@@ -1067,7 +1087,9 @@ public final CompletableFuture
+ * 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
@@ -1839,8 +1861,9 @@ public final CompletableFuture
+ * Deletes a stored script or search template.
*
* @see Documentation
@@ -1855,8 +1878,9 @@ public CompletableFuture
+ * Deletes a stored script or search template.
*
* @param fn
* a function that initializes a builder to create the
@@ -2002,9 +2026,10 @@ public final CompletableFuture
+ * 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
@@ -2022,9 +2047,10 @@ public
+ * 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
@@ -2061,9 +2087,10 @@ public final CompletableFuture
+ * 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
@@ -2081,9 +2108,10 @@ public
+ * 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
@@ -2541,8 +2569,9 @@ public final
+ * Retrieves a stored script or search template.
*
* @see Documentation
@@ -2557,8 +2586,9 @@ public CompletableFuture
+ * Retrieves a stored script or search template.
*
* @param fn
* a function that initializes a builder to create the
@@ -2761,9 +2791,10 @@ public final
+ * 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
@@ -2803,9 +2834,10 @@ public CompletableFuture
+ * 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
@@ -2846,9 +2878,10 @@ public final CompletableFuture
+ * 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
@@ -3297,9 +3330,11 @@ public final
+ * 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
@@ -4048,7 +4083,9 @@ public final CompletableFuture
+ * Get information about whether the cluster is running.
*
* @see Documentation
@@ -4061,8 +4098,9 @@ public CompletableFuture
+ * Creates or updates a stored script or search template.
*
* @see Documentation
@@ -4077,8 +4115,9 @@ public CompletableFuture
+ * Creates or updates a stored script or search template.
*
* @param fn
* a function that initializes a builder to create the
@@ -6140,10 +6179,11 @@ public final
* If the Elasticsearch security features are enabled, you must have the
* following index privileges for the target data stream, index, or alias:
@@ -6301,10 +6341,11 @@ public 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:
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 fa0bc36ac..1a55d296f 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
@@ -383,10 +383,11 @@ public ElasticsearchXpackClient xpack() {
// ----- Endpoint: bulk
/**
- * Bulk index or delete documents. Perform multiple
+ * Perform multiple
* If the Elasticsearch security features are enabled, you must have the
* following index privileges for the target data stream, index, or index alias:
@@ -483,6 +484,8 @@ public ElasticsearchXpackClient xpack() {
*
+ * Perform multiple
* If the Elasticsearch security features are enabled, you must have the
* following index privileges for the target data stream, index, or index alias:
@@ -662,6 +666,8 @@ public BulkResponse bulk(BulkRequest request) throws IOException, ElasticsearchE
*
+ * Perform multiple
* If the Elasticsearch security features are enabled, you must have the
* following index privileges for the target data stream, index, or index alias:
@@ -842,6 +849,8 @@ public final BulkResponse bulk(Function
+ * Clear the search context and results for a scrolling search.
*
* @see Documentation
@@ -937,8 +947,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
@@ -955,8 +966,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
@@ -971,12 +983,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
+ * A point in time must be opened explicitly before being used in search
+ * requests. The
+ * A point in time must be opened explicitly before being used in search
+ * requests. The
+ * 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
@@ -1043,7 +1061,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
@@ -1071,7 +1091,9 @@ public final CountResponse count(Function
* 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
@@ -1848,8 +1870,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
@@ -1864,8 +1887,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
@@ -2013,9 +2037,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
@@ -2033,9 +2058,10 @@ public
+ * 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
@@ -2073,9 +2099,10 @@ public final ExplainResponse
+ * 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
@@ -2556,8 +2584,9 @@ public final
+ * Retrieves a stored script or search template.
*
* @param fn
* a function that initializes a builder to create the
@@ -2779,9 +2809,10 @@ public final
+ * 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
@@ -2821,9 +2852,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
@@ -2865,9 +2897,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
@@ -3317,9 +3350,11 @@ public final
+ * 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
@@ -4077,7 +4112,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
@@ -4090,8 +4127,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
@@ -4106,8 +4144,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
@@ -6189,10 +6228,11 @@ public final
+ * 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:
@@ -6351,10 +6391,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 847f53897..4d21f812c 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
+ * 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
+ * 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
+ * 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
+ * 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
+ * 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
+ * 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
+ * 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
+ * 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 87cdd47a3..accce4a70 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 a9e968997..55793614e 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 0881761e6..d82c981d6 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 a98cd5d5d..26f6535c9 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 587e9efb8..7011f360a 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 dcaaaecc8..8b7d8e261 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,16 +60,18 @@
// typedef: cluster.allocation_explain.Request
/**
- * Explain the shard allocations. Get explanations for shard allocations in the
- * cluster. This API accepts the current_node, index, primary and shard
- * parameters in the request body or in query parameters, but not in both at the
- * same time. 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. This API accepts the
+ * current_node, index, primary and shard parameters in the request body or in
+ * query parameters, but not in both at the same time. 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 e0cbc76f9..22646ebbf 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 0d4e38fc4..76217bc81 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 095f694f7..2ab2efd72 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 f2693fb57..3c0198320 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 1d54471dd..9cca5bca5 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,16 +71,18 @@ public ElasticsearchClusterAsyncClient withTransportOptions(@Nullable TransportO
// ----- Endpoint: cluster.allocation_explain
/**
- * Explain the shard allocations. Get explanations for shard allocations in the
- * cluster. This API accepts the current_node, index, primary and shard
- * parameters in the request body or in query parameters, but not in both at the
- * same time. 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. This API accepts the
+ * current_node, index, primary and shard parameters in the request body or in
+ * query parameters, but not in both at the same time. 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
@@ -95,16 +97,18 @@ public CompletableFuture
+ * Get explanations for shard allocations in the cluster. This API accepts the
+ * current_node, index, primary and shard parameters in the request body or in
+ * query parameters, but not in both at the same time. 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
@@ -120,16 +124,18 @@ public final CompletableFuture
+ * Get explanations for shard allocations in the cluster. This API accepts the
+ * current_node, index, primary and shard parameters in the request body or in
+ * query parameters, but not in both at the same time. 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
@@ -144,9 +150,10 @@ public CompletableFuture
+ * Component templates are building blocks for constructing index templates that
+ * specify index mappings, settings, and aliases.
*
* @see Documentation
@@ -162,9 +169,10 @@ public CompletableFuture
+ * 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
@@ -182,8 +190,9 @@ public final CompletableFuture
+ * Remove master-eligible nodes from the voting configuration exclusion list.
*
* @see Documentation
@@ -199,8 +208,9 @@ public CompletableFuture
+ * Remove master-eligible nodes from the voting configuration exclusion list.
*
* @param fn
* a function that initializes a builder to create the
@@ -216,8 +226,9 @@ public final CompletableFuture
+ * Remove master-eligible nodes from the voting configuration exclusion list.
*
* @see Documentation
@@ -232,8 +243,9 @@ public CompletableFuture
+ * Returns information about whether a particular component template exists.
*
* @see Documentation
@@ -248,8 +260,9 @@ public CompletableFuture
+ * Returns information about whether a particular component template exists.
*
* @param fn
* a function that initializes a builder to create the
@@ -267,7 +280,9 @@ public final CompletableFuture
+ * Get information about component templates.
*
* @see Documentation
@@ -282,7 +297,9 @@ public CompletableFuture
+ * Get information about component templates.
*
* @param fn
* a function that initializes a builder to create the
@@ -298,7 +315,9 @@ public final CompletableFuture
+ * Get information about component templates.
*
* @see Documentation
@@ -453,7 +472,9 @@ public CompletableFuture
+ * Returns basic information about the cluster.
*
* @see Documentation
@@ -468,7 +489,9 @@ public CompletableFuture
+ * Returns basic information about the cluster.
*
* @param fn
* a function that initializes a builder to create the
@@ -486,9 +509,10 @@ public final CompletableFuture
+ * 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
@@ -510,9 +534,10 @@ public CompletableFuture
+ * 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
@@ -535,9 +560,10 @@ public final CompletableFuture
+ * 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
@@ -559,16 +585,17 @@ public CompletableFuture
+ * 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.
@@ -609,16 +636,17 @@ public CompletableFuture
+ * 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.
@@ -660,16 +688,17 @@ public final CompletableFuture
+ * 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.
@@ -710,9 +739,10 @@ public CompletableFuture
+ * 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
@@ -751,9 +781,10 @@ public CompletableFuture
+ * 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
@@ -955,10 +986,12 @@ public CompletableFuture
+ * 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
@@ -996,10 +1029,12 @@ public CompletableFuture
+ * 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
@@ -1038,10 +1073,12 @@ public final CompletableFuture
+ * 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
@@ -1079,8 +1116,9 @@ public CompletableFuture
+ * 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
@@ -1123,8 +1161,9 @@ public CompletableFuture
+ * 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
@@ -1168,8 +1207,9 @@ public final CompletableFuture
+ * 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
@@ -1212,9 +1252,11 @@ public CompletableFuture
+ * 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
@@ -1229,9 +1271,11 @@ public CompletableFuture
+ * 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
@@ -1247,9 +1291,11 @@ public final CompletableFuture
+ * 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 4e6b8f391..0465f6183 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,16 +69,18 @@ public ElasticsearchClusterClient withTransportOptions(@Nullable TransportOption
// ----- Endpoint: cluster.allocation_explain
/**
- * Explain the shard allocations. Get explanations for shard allocations in the
- * cluster. This API accepts the current_node, index, primary and shard
- * parameters in the request body or in query parameters, but not in both at the
- * same time. 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. This API accepts the
+ * current_node, index, primary and shard parameters in the request body or in
+ * query parameters, but not in both at the same time. 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
@@ -94,16 +96,18 @@ public AllocationExplainResponse allocationExplain(AllocationExplainRequest requ
}
/**
- * Explain the shard allocations. Get explanations for shard allocations in the
- * cluster. This API accepts the current_node, index, primary and shard
- * parameters in the request body or in query parameters, but not in both at the
- * same time. 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. This API accepts the
+ * current_node, index, primary and shard parameters in the request body or in
+ * query parameters, but not in both at the same time. 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
@@ -120,16 +124,18 @@ public final AllocationExplainResponse allocationExplain(
}
/**
- * Explain the shard allocations. Get explanations for shard allocations in the
- * cluster. This API accepts the current_node, index, primary and shard
- * parameters in the request body or in query parameters, but not in both at the
- * same time. 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. This API accepts the
+ * current_node, index, primary and shard parameters in the request body or in
+ * query parameters, but not in both at the same time. 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
@@ -144,9 +150,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
@@ -162,9 +169,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
@@ -183,8 +191,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
@@ -200,8 +209,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
@@ -218,8 +228,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
@@ -234,8 +245,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
@@ -251,8 +263,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
@@ -271,7 +284,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
@@ -287,7 +302,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
@@ -304,7 +321,9 @@ public final GetComponentTemplateResponse getComponentTemplate(
}
/**
- * Get component templates. Get information about component templates.
+ * Get component templates.
+ *
+ * Get information about component templates.
*
* @see Documentation
@@ -461,7 +480,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
@@ -476,7 +497,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
@@ -494,9 +517,10 @@ public final ClusterInfoResponse info(Function
* 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
@@ -518,9 +542,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
@@ -544,9 +569,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
@@ -568,16 +594,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.
@@ -619,16 +646,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.
@@ -671,16 +699,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.
@@ -721,9 +750,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
@@ -763,9 +793,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
@@ -970,10 +1001,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
@@ -1011,10 +1044,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
@@ -1053,10 +1088,12 @@ public final RerouteResponse reroute(Function
* It is important to note that after processing any reroute commands
* Elasticsearch will perform rebalancing as normal (respecting the values of
@@ -1094,8 +1131,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
@@ -1138,8 +1176,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
@@ -1183,8 +1222,9 @@ public final StateResponse state(Function
* The cluster state is an internal data structure which keeps track of a
* variety of information needed by every node, including the identity and
@@ -1227,9 +1267,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
@@ -1244,9 +1286,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
@@ -1263,9 +1307,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 59e35effa..af7b715d1 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 e0674420e..4c0d2eea2 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.
+ * Search::Elasticsearch::Client::5_0::Scroll
* elasticsearch.helpers.*client.helpers.*co.elastic.clients.elasticsearch._helpers.bulk.BulkIngesterBulkAllObservableElasticsearch::Helpers::BulkHelpercreate, delete, and update actions in
- * a single request. This reduces overhead and can greatly increase indexing
- * speed.
+ * Bulk index or delete documents.
+ * index, create,
+ * delete, and update actions in a single request.
+ * This reduces overhead and can greatly increase indexing speed.
* elasticsearch.helpers.*client.helpers.*co.elastic.clients.elasticsearch._helpers.bulk.BulkIngesterBulkAllObservableElasticsearch::Helpers::BulkHelperkeep_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.
+ * 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
@@ -989,12 +1003,14 @@ public CompletableFuturekeep_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.
+ * 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
@@ -1012,7 +1028,9 @@ public final CompletableFutureindex,
- * create, delete, and update actions in
- * a single request. This reduces overhead and can greatly increase indexing
- * speed.
+ * Bulk index or delete documents.
+ * index, create,
+ * delete, and update actions in a single request.
+ * This reduces overhead and can greatly increase indexing speed.
* Search::Elasticsearch::Client::5_0::Scroll
* elasticsearch.helpers.*client.helpers.*co.elastic.clients.elasticsearch._helpers.bulk.BulkIngesterBulkAllObservableElasticsearch::Helpers::BulkHelperindex,
- * create, delete, and update actions in
- * a single request. This reduces overhead and can greatly increase indexing
- * speed.
+ * Bulk index or delete documents.
+ * index, create,
+ * delete, and update actions in a single request.
+ * This reduces overhead and can greatly increase indexing speed.
* Search::Elasticsearch::Client::5_0::Scroll
* elasticsearch.helpers.*client.helpers.*co.elastic.clients.elasticsearch._helpers.bulk.BulkIngesterBulkAllObservableElasticsearch::Helpers::BulkHelpercreate, delete, and update actions in
- * a single request. This reduces overhead and can greatly increase indexing
- * speed.
+ * Bulk index or delete documents.
+ * index, create,
+ * delete, and update actions in a single request.
+ * This reduces overhead and can greatly increase indexing speed.
* elasticsearch.helpers.*client.helpers.*co.elastic.clients.elasticsearch._helpers.bulk.BulkIngesterBulkAllObservableElasticsearch::Helpers::BulkHelperkeep_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.
+ * 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
@@ -992,12 +1006,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.
+ * 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
@@ -1016,7 +1032,9 @@ public final ClosePointInTimeResponse closePointInTime(
// ----- Endpoint: count
/**
- * Count search results. Get the number of documents matching a query.
+ * Count search results.
+ *