@@ -71,15 +71,15 @@ public ElasticsearchAsyncSearchClient withTransportOptions(@Nullable TransportOp
71
71
// ----- Endpoint: async_search.delete
72
72
73
73
/**
74
- * Deletes an async search by identifier . If the search is still running, the
75
- * search request will be cancelled. Otherwise, the saved search results are
76
- * deleted. If the Elasticsearch security features are enabled, the deletion of
77
- * a specific async search is restricted to: the authenticated user that
78
- * submitted the original search request; users that have the
79
- * <code>cancel_task</code> cluster privilege.
74
+ * Delete an async search. If the asynchronous search is still running, it is
75
+ * cancelled. Otherwise, the saved search results are deleted. If the
76
+ * Elasticsearch security features are enabled, the deletion of a specific async
77
+ * search is restricted to: the authenticated user that submitted the original
78
+ * search request; users that have the <code>cancel_task</code> cluster
79
+ * privilege.
80
80
*
81
81
* @see <a href=
82
- * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16 /async-search.html">Documentation
82
+ * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17 /async-search.html">Documentation
83
83
* on elastic.co</a>
84
84
*/
85
85
@@ -92,18 +92,18 @@ public DeleteAsyncSearchResponse delete(DeleteAsyncSearchRequest request)
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
104
104
* {@link DeleteAsyncSearchRequest}
105
105
* @see <a href=
106
- * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16 /async-search.html">Documentation
106
+ * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17 /async-search.html">Documentation
107
107
* on elastic.co</a>
108
108
*/
109
109
@@ -116,13 +116,13 @@ public final DeleteAsyncSearchResponse delete(
116
116
// ----- Endpoint: async_search.get
117
117
118
118
/**
119
- * Retrieves the results of a previously submitted async search request given
120
- * its identifier . If the Elasticsearch security features are enabled, access to
121
- * the results of a specific async search is restricted to the user or API key
122
- * that submitted it.
119
+ * Get async search results. Retrieve the results of a previously submitted
120
+ * asynchronous search request . If the Elasticsearch security features are
121
+ * enabled, access to the results of a specific async search is restricted to
122
+ * the user or API key that submitted it.
123
123
*
124
124
* @see <a href=
125
- * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16 /async-search.html">Documentation
125
+ * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17 /async-search.html">Documentation
126
126
* on elastic.co</a>
127
127
*/
128
128
@@ -137,16 +137,16 @@ public <TDocument> GetAsyncSearchResponse<TDocument> get(GetAsyncSearchRequest r
137
137
}
138
138
139
139
/**
140
- * Retrieves the results of a previously submitted async search request given
141
- * its identifier . If the Elasticsearch security features are enabled, access to
142
- * the results of a specific async search is restricted to the user or API key
143
- * that submitted it.
140
+ * Get async search results. Retrieve the results of a previously submitted
141
+ * asynchronous search request . If the Elasticsearch security features are
142
+ * enabled, access to the results of a specific async search is restricted to
143
+ * the user or API key that submitted it.
144
144
*
145
145
* @param fn
146
146
* a function that initializes a builder to create the
147
147
* {@link GetAsyncSearchRequest}
148
148
* @see <a href=
149
- * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16 /async-search.html">Documentation
149
+ * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17 /async-search.html">Documentation
150
150
* on elastic.co</a>
151
151
*/
152
152
@@ -157,13 +157,13 @@ public final <TDocument> GetAsyncSearchResponse<TDocument> get(
157
157
}
158
158
159
159
/**
160
- * Retrieves the results of a previously submitted async search request given
161
- * its identifier . If the Elasticsearch security features are enabled, access to
162
- * the results of a specific async search is restricted to the user or API key
163
- * that submitted it.
160
+ * Get async search results. Retrieve the results of a previously submitted
161
+ * asynchronous search request . If the Elasticsearch security features are
162
+ * enabled, access to the results of a specific async search is restricted to
163
+ * the user or API key that submitted it.
164
164
*
165
165
* @see <a href=
166
- * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16 /async-search.html">Documentation
166
+ * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17 /async-search.html">Documentation
167
167
* on elastic.co</a>
168
168
*/
169
169
@@ -178,16 +178,16 @@ public <TDocument> GetAsyncSearchResponse<TDocument> get(GetAsyncSearchRequest r
178
178
}
179
179
180
180
/**
181
- * Retrieves the results of a previously submitted async search request given
182
- * its identifier . If the Elasticsearch security features are enabled, access to
183
- * the results of a specific async search is restricted to the user or API key
184
- * that submitted it.
181
+ * Get async search results. Retrieve the results of a previously submitted
182
+ * asynchronous search request . If the Elasticsearch security features are
183
+ * enabled, access to the results of a specific async search is restricted to
184
+ * the user or API key that submitted it.
185
185
*
186
186
* @param fn
187
187
* a function that initializes a builder to create the
188
188
* {@link GetAsyncSearchRequest}
189
189
* @see <a href=
190
- * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16 /async-search.html">Documentation
190
+ * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17 /async-search.html">Documentation
191
191
* on elastic.co</a>
192
192
*/
193
193
@@ -200,13 +200,13 @@ public final <TDocument> GetAsyncSearchResponse<TDocument> get(
200
200
// ----- Endpoint: async_search.status
201
201
202
202
/**
203
- * Get async search status Retrieves the status of a previously submitted async
203
+ * Get async search status. Retrieve the status of a previously submitted async
204
204
* search request given its identifier, without retrieving search results. If
205
205
* the Elasticsearch security features are enabled, use of this API is
206
206
* restricted to the <code>monitoring_user</code> role.
207
207
*
208
208
* @see <a href=
209
- * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16 /async-search.html">Documentation
209
+ * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17 /async-search.html">Documentation
210
210
* on elastic.co</a>
211
211
*/
212
212
@@ -219,7 +219,7 @@ public AsyncSearchStatusResponse status(AsyncSearchStatusRequest request)
219
219
}
220
220
221
221
/**
222
- * Get async search status Retrieves the status of a previously submitted async
222
+ * Get async search status. Retrieve the status of a previously submitted async
223
223
* search request given its identifier, without retrieving search results. If
224
224
* the Elasticsearch security features are enabled, use of this API is
225
225
* restricted to the <code>monitoring_user</code> role.
@@ -228,7 +228,7 @@ public AsyncSearchStatusResponse status(AsyncSearchStatusRequest request)
228
228
* a function that initializes a builder to create the
229
229
* {@link AsyncSearchStatusRequest}
230
230
* @see <a href=
231
- * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16 /async-search.html">Documentation
231
+ * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17 /async-search.html">Documentation
232
232
* on elastic.co</a>
233
233
*/
234
234
@@ -241,18 +241,22 @@ public final AsyncSearchStatusResponse status(
241
241
// ----- Endpoint: async_search.submit
242
242
243
243
/**
244
- * Runs a search request asynchronously. When the primary sort of the results is
245
- * an indexed field, shards get sorted based on minimum and maximum value that
246
- * they hold for that field, hence partial results become available following
247
- * the sort criteria that was requested. Warning: Async search does not support
248
- * scroll nor search requests that only include the suggest section. By default,
249
- * Elasticsearch doesn’t allow you to store an async search response larger than
250
- * 10Mb and an attempt to do this results in an error. The maximum allowed size
251
- * for a stored async search response can be set by changing the
252
- * <code>search.max_async_search_response_size</code> cluster level setting.
244
+ * Run an async search. When the primary sort of the results is an indexed
245
+ * field, shards get sorted based on minimum and maximum value that they hold
246
+ * for that field. Partial results become available following the sort criteria
247
+ * that was requested.
248
+ * <p>
249
+ * Warning: Asynchronous search does not support scroll or search requests that
250
+ * include only the suggest section.
251
+ * <p>
252
+ * By default, Elasticsearch does not allow you to store an async search
253
+ * response larger than 10Mb and an attempt to do this results in an error. The
254
+ * maximum allowed size for a stored async search response can be set by
255
+ * changing the <code>search.max_async_search_response_size</code> cluster level
256
+ * setting.
253
257
*
254
258
* @see <a href=
255
- * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16 /async-search.html">Documentation
259
+ * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17 /async-search.html">Documentation
256
260
* on elastic.co</a>
257
261
*/
258
262
@@ -268,21 +272,25 @@ public <TDocument> SubmitResponse<TDocument> submit(SubmitRequest request, Class
268
272
}
269
273
270
274
/**
271
- * Runs a search request asynchronously. When the primary sort of the results is
272
- * an indexed field, shards get sorted based on minimum and maximum value that
273
- * they hold for that field, hence partial results become available following
274
- * the sort criteria that was requested. Warning: Async search does not support
275
- * scroll nor search requests that only include the suggest section. By default,
276
- * Elasticsearch doesn’t allow you to store an async search response larger than
277
- * 10Mb and an attempt to do this results in an error. The maximum allowed size
278
- * for a stored async search response can be set by changing the
279
- * <code>search.max_async_search_response_size</code> cluster level setting.
275
+ * Run an async search. When the primary sort of the results is an indexed
276
+ * field, shards get sorted based on minimum and maximum value that they hold
277
+ * for that field. Partial results become available following the sort criteria
278
+ * that was requested.
279
+ * <p>
280
+ * Warning: Asynchronous search does not support scroll or search requests that
281
+ * include only the suggest section.
282
+ * <p>
283
+ * By default, Elasticsearch does not allow you to store an async search
284
+ * response larger than 10Mb and an attempt to do this results in an error. The
285
+ * maximum allowed size for a stored async search response can be set by
286
+ * changing the <code>search.max_async_search_response_size</code> cluster level
287
+ * setting.
280
288
*
281
289
* @param fn
282
290
* a function that initializes a builder to create the
283
291
* {@link SubmitRequest}
284
292
* @see <a href=
285
- * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16 /async-search.html">Documentation
293
+ * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17 /async-search.html">Documentation
286
294
* on elastic.co</a>
287
295
*/
288
296
@@ -293,18 +301,22 @@ public final <TDocument> SubmitResponse<TDocument> submit(
293
301
}
294
302
295
303
/**
296
- * Runs a search request asynchronously. When the primary sort of the results is
297
- * an indexed field, shards get sorted based on minimum and maximum value that
298
- * they hold for that field, hence partial results become available following
299
- * the sort criteria that was requested. Warning: Async search does not support
300
- * scroll nor search requests that only include the suggest section. By default,
301
- * Elasticsearch doesn’t allow you to store an async search response larger than
302
- * 10Mb and an attempt to do this results in an error. The maximum allowed size
303
- * for a stored async search response can be set by changing the
304
- * <code>search.max_async_search_response_size</code> cluster level setting.
304
+ * Run an async search. When the primary sort of the results is an indexed
305
+ * field, shards get sorted based on minimum and maximum value that they hold
306
+ * for that field. Partial results become available following the sort criteria
307
+ * that was requested.
308
+ * <p>
309
+ * Warning: Asynchronous search does not support scroll or search requests that
310
+ * include only the suggest section.
311
+ * <p>
312
+ * By default, Elasticsearch does not allow you to store an async search
313
+ * response larger than 10Mb and an attempt to do this results in an error. The
314
+ * maximum allowed size for a stored async search response can be set by
315
+ * changing the <code>search.max_async_search_response_size</code> cluster level
316
+ * setting.
305
317
*
306
318
* @see <a href=
307
- * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16 /async-search.html">Documentation
319
+ * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17 /async-search.html">Documentation
308
320
* on elastic.co</a>
309
321
*/
310
322
@@ -320,21 +332,25 @@ public <TDocument> SubmitResponse<TDocument> submit(SubmitRequest request, Type
320
332
}
321
333
322
334
/**
323
- * Runs a search request asynchronously. When the primary sort of the results is
324
- * an indexed field, shards get sorted based on minimum and maximum value that
325
- * they hold for that field, hence partial results become available following
326
- * the sort criteria that was requested. Warning: Async search does not support
327
- * scroll nor search requests that only include the suggest section. By default,
328
- * Elasticsearch doesn’t allow you to store an async search response larger than
329
- * 10Mb and an attempt to do this results in an error. The maximum allowed size
330
- * for a stored async search response can be set by changing the
331
- * <code>search.max_async_search_response_size</code> cluster level setting.
335
+ * Run an async search. When the primary sort of the results is an indexed
336
+ * field, shards get sorted based on minimum and maximum value that they hold
337
+ * for that field. Partial results become available following the sort criteria
338
+ * that was requested.
339
+ * <p>
340
+ * Warning: Asynchronous search does not support scroll or search requests that
341
+ * include only the suggest section.
342
+ * <p>
343
+ * By default, Elasticsearch does not allow you to store an async search
344
+ * response larger than 10Mb and an attempt to do this results in an error. The
345
+ * maximum allowed size for a stored async search response can be set by
346
+ * changing the <code>search.max_async_search_response_size</code> cluster level
347
+ * setting.
332
348
*
333
349
* @param fn
334
350
* a function that initializes a builder to create the
335
351
* {@link SubmitRequest}
336
352
* @see <a href=
337
- * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16 /async-search.html">Documentation
353
+ * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17 /async-search.html">Documentation
338
354
* on elastic.co</a>
339
355
*/
340
356
0 commit comments