@@ -72,12 +72,12 @@ public ElasticsearchAsyncSearchAsyncClient withTransportOptions(@Nullable Transp
72
72
// ----- Endpoint: async_search.delete
73
73
74
74
/**
75
- * Deletes an async search by identifier . If the search is still running, the
76
- * search request will be cancelled. Otherwise, the saved search results are
77
- * deleted. If the Elasticsearch security features are enabled, the deletion of
78
- * a specific async search is restricted to: the authenticated user that
79
- * submitted the original search request; users that have the
80
- * <code>cancel_task</code> cluster privilege.
75
+ * Delete an async search. If the asynchronous search is still running, it is
76
+ * cancelled. Otherwise, the saved search results are deleted. If the
77
+ * Elasticsearch security features are enabled, the deletion of a specific async
78
+ * search is restricted to: the authenticated user that submitted the original
79
+ * search request; users that have the <code>cancel_task</code> cluster
80
+ * privilege.
81
81
*
82
82
* @see <a href=
83
83
* "https://www.elastic.co/guide/en/elasticsearch/reference/9.0/async-search.html">Documentation
@@ -92,12 +92,12 @@ public CompletableFuture<DeleteAsyncSearchResponse> delete(DeleteAsyncSearchRequ
92
92
}
93
93
94
94
/**
95
- * Deletes an async search by identifier . If the search is still running, the
96
- * search request will be cancelled. Otherwise, the saved search results are
97
- * deleted. If the Elasticsearch security features are enabled, the deletion of
98
- * a specific async search is restricted to: the authenticated user that
99
- * submitted the original search request; users that have the
100
- * <code>cancel_task</code> cluster privilege.
95
+ * Delete an async search. If the asynchronous search is still running, it is
96
+ * cancelled. Otherwise, the saved search results are deleted. If the
97
+ * Elasticsearch security features are enabled, the deletion of a specific async
98
+ * search is restricted to: the authenticated user that submitted the original
99
+ * search request; users that have the <code>cancel_task</code> cluster
100
+ * privilege.
101
101
*
102
102
* @param fn
103
103
* a function that initializes a builder to create the
@@ -115,10 +115,10 @@ public final CompletableFuture<DeleteAsyncSearchResponse> delete(
115
115
// ----- Endpoint: async_search.get
116
116
117
117
/**
118
- * Retrieves the results of a previously submitted async search request given
119
- * its identifier . If the Elasticsearch security features are enabled, access to
120
- * the results of a specific async search is restricted to the user or API key
121
- * that submitted it.
118
+ * Get async search results. Retrieve the results of a previously submitted
119
+ * asynchronous search request . If the Elasticsearch security features are
120
+ * enabled, access to the results of a specific async search is restricted to
121
+ * the user or API key that submitted it.
122
122
*
123
123
* @see <a href=
124
124
* "https://www.elastic.co/guide/en/elasticsearch/reference/9.0/async-search.html">Documentation
@@ -136,10 +136,10 @@ public <TDocument> CompletableFuture<GetAsyncSearchResponse<TDocument>> get(GetA
136
136
}
137
137
138
138
/**
139
- * Retrieves the results of a previously submitted async search request given
140
- * its identifier . If the Elasticsearch security features are enabled, access to
141
- * the results of a specific async search is restricted to the user or API key
142
- * that submitted it.
139
+ * Get async search results. Retrieve the results of a previously submitted
140
+ * asynchronous search request . If the Elasticsearch security features are
141
+ * enabled, access to the results of a specific async search is restricted to
142
+ * the user or API key that submitted it.
143
143
*
144
144
* @param fn
145
145
* a function that initializes a builder to create the
@@ -156,10 +156,10 @@ public final <TDocument> CompletableFuture<GetAsyncSearchResponse<TDocument>> ge
156
156
}
157
157
158
158
/**
159
- * Retrieves the results of a previously submitted async search request given
160
- * its identifier . If the Elasticsearch security features are enabled, access to
161
- * the results of a specific async search is restricted to the user or API key
162
- * that submitted it.
159
+ * Get async search results. Retrieve the results of a previously submitted
160
+ * asynchronous search request . If the Elasticsearch security features are
161
+ * enabled, access to the results of a specific async search is restricted to
162
+ * the user or API key that submitted it.
163
163
*
164
164
* @see <a href=
165
165
* "https://www.elastic.co/guide/en/elasticsearch/reference/9.0/async-search.html">Documentation
@@ -177,10 +177,10 @@ public <TDocument> CompletableFuture<GetAsyncSearchResponse<TDocument>> get(GetA
177
177
}
178
178
179
179
/**
180
- * Retrieves the results of a previously submitted async search request given
181
- * its identifier . If the Elasticsearch security features are enabled, access to
182
- * the results of a specific async search is restricted to the user or API key
183
- * that submitted it.
180
+ * Get async search results. Retrieve the results of a previously submitted
181
+ * asynchronous search request . If the Elasticsearch security features are
182
+ * enabled, access to the results of a specific async search is restricted to
183
+ * the user or API key that submitted it.
184
184
*
185
185
* @param fn
186
186
* a function that initializes a builder to create the
@@ -198,7 +198,7 @@ public final <TDocument> CompletableFuture<GetAsyncSearchResponse<TDocument>> ge
198
198
// ----- Endpoint: async_search.status
199
199
200
200
/**
201
- * Get async search status Retrieves the status of a previously submitted async
201
+ * Get async search status. Retrieve the status of a previously submitted async
202
202
* search request given its identifier, without retrieving search results. If
203
203
* the Elasticsearch security features are enabled, use of this API is
204
204
* restricted to the <code>monitoring_user</code> role.
@@ -216,7 +216,7 @@ public CompletableFuture<AsyncSearchStatusResponse> status(AsyncSearchStatusRequ
216
216
}
217
217
218
218
/**
219
- * Get async search status Retrieves the status of a previously submitted async
219
+ * Get async search status. Retrieve the status of a previously submitted async
220
220
* search request given its identifier, without retrieving search results. If
221
221
* the Elasticsearch security features are enabled, use of this API is
222
222
* restricted to the <code>monitoring_user</code> role.
@@ -237,15 +237,19 @@ public final CompletableFuture<AsyncSearchStatusResponse> status(
237
237
// ----- Endpoint: async_search.submit
238
238
239
239
/**
240
- * Runs a search request asynchronously. When the primary sort of the results is
241
- * an indexed field, shards get sorted based on minimum and maximum value that
242
- * they hold for that field, hence partial results become available following
243
- * the sort criteria that was requested. Warning: Async search does not support
244
- * scroll nor search requests that only include the suggest section. By default,
245
- * Elasticsearch doesn’t allow you to store an async search response larger than
246
- * 10Mb and an attempt to do this results in an error. The maximum allowed size
247
- * for a stored async search response can be set by changing the
248
- * <code>search.max_async_search_response_size</code> cluster level setting.
240
+ * Run an async search. When the primary sort of the results is an indexed
241
+ * field, shards get sorted based on minimum and maximum value that they hold
242
+ * for that field. Partial results become available following the sort criteria
243
+ * that was requested.
244
+ * <p>
245
+ * Warning: Asynchronous search does not support scroll or search requests that
246
+ * include only the suggest section.
247
+ * <p>
248
+ * By default, Elasticsearch does not allow you to store an async search
249
+ * response larger than 10Mb and an attempt to do this results in an error. The
250
+ * maximum allowed size for a stored async search response can be set by
251
+ * changing the <code>search.max_async_search_response_size</code> cluster level
252
+ * setting.
249
253
*
250
254
* @see <a href=
251
255
* "https://www.elastic.co/guide/en/elasticsearch/reference/9.0/async-search.html">Documentation
@@ -264,15 +268,19 @@ public <TDocument> CompletableFuture<SubmitResponse<TDocument>> submit(SubmitReq
264
268
}
265
269
266
270
/**
267
- * Runs a search request asynchronously. When the primary sort of the results is
268
- * an indexed field, shards get sorted based on minimum and maximum value that
269
- * they hold for that field, hence partial results become available following
270
- * the sort criteria that was requested. Warning: Async search does not support
271
- * scroll nor search requests that only include the suggest section. By default,
272
- * Elasticsearch doesn’t allow you to store an async search response larger than
273
- * 10Mb and an attempt to do this results in an error. The maximum allowed size
274
- * for a stored async search response can be set by changing the
275
- * <code>search.max_async_search_response_size</code> cluster level setting.
271
+ * Run an async search. When the primary sort of the results is an indexed
272
+ * field, shards get sorted based on minimum and maximum value that they hold
273
+ * for that field. Partial results become available following the sort criteria
274
+ * that was requested.
275
+ * <p>
276
+ * Warning: Asynchronous search does not support scroll or search requests that
277
+ * include only the suggest section.
278
+ * <p>
279
+ * By default, Elasticsearch does not allow you to store an async search
280
+ * response larger than 10Mb and an attempt to do this results in an error. The
281
+ * maximum allowed size for a stored async search response can be set by
282
+ * changing the <code>search.max_async_search_response_size</code> cluster level
283
+ * setting.
276
284
*
277
285
* @param fn
278
286
* a function that initializes a builder to create the
@@ -288,15 +296,19 @@ public final <TDocument> CompletableFuture<SubmitResponse<TDocument>> submit(
288
296
}
289
297
290
298
/**
291
- * Runs a search request asynchronously. When the primary sort of the results is
292
- * an indexed field, shards get sorted based on minimum and maximum value that
293
- * they hold for that field, hence partial results become available following
294
- * the sort criteria that was requested. Warning: Async search does not support
295
- * scroll nor search requests that only include the suggest section. By default,
296
- * Elasticsearch doesn’t allow you to store an async search response larger than
297
- * 10Mb and an attempt to do this results in an error. The maximum allowed size
298
- * for a stored async search response can be set by changing the
299
- * <code>search.max_async_search_response_size</code> cluster level setting.
299
+ * Run an async search. When the primary sort of the results is an indexed
300
+ * field, shards get sorted based on minimum and maximum value that they hold
301
+ * for that field. Partial results become available following the sort criteria
302
+ * that was requested.
303
+ * <p>
304
+ * Warning: Asynchronous search does not support scroll or search requests that
305
+ * include only the suggest section.
306
+ * <p>
307
+ * By default, Elasticsearch does not allow you to store an async search
308
+ * response larger than 10Mb and an attempt to do this results in an error. The
309
+ * maximum allowed size for a stored async search response can be set by
310
+ * changing the <code>search.max_async_search_response_size</code> cluster level
311
+ * setting.
300
312
*
301
313
* @see <a href=
302
314
* "https://www.elastic.co/guide/en/elasticsearch/reference/9.0/async-search.html">Documentation
@@ -314,15 +326,19 @@ public <TDocument> CompletableFuture<SubmitResponse<TDocument>> submit(SubmitReq
314
326
}
315
327
316
328
/**
317
- * Runs a search request asynchronously. When the primary sort of the results is
318
- * an indexed field, shards get sorted based on minimum and maximum value that
319
- * they hold for that field, hence partial results become available following
320
- * the sort criteria that was requested. Warning: Async search does not support
321
- * scroll nor search requests that only include the suggest section. By default,
322
- * Elasticsearch doesn’t allow you to store an async search response larger than
323
- * 10Mb and an attempt to do this results in an error. The maximum allowed size
324
- * for a stored async search response can be set by changing the
325
- * <code>search.max_async_search_response_size</code> cluster level setting.
329
+ * Run an async search. When the primary sort of the results is an indexed
330
+ * field, shards get sorted based on minimum and maximum value that they hold
331
+ * for that field. Partial results become available following the sort criteria
332
+ * that was requested.
333
+ * <p>
334
+ * Warning: Asynchronous search does not support scroll or search requests that
335
+ * include only the suggest section.
336
+ * <p>
337
+ * By default, Elasticsearch does not allow you to store an async search
338
+ * response larger than 10Mb and an attempt to do this results in an error. The
339
+ * maximum allowed size for a stored async search response can be set by
340
+ * changing the <code>search.max_async_search_response_size</code> cluster level
341
+ * setting.
326
342
*
327
343
* @param fn
328
344
* a function that initializes a builder to create the
0 commit comments