@@ -4933,58 +4933,6 @@ public final <TDocument> CompletableFuture<SearchResponse<TDocument>> search(
49334933 * labels, so that, for example, multi-polygons will have only one label.</li>
49344934 * </ul>
49354935 * <p>
4936- * For example, Elasticsearch may translate a vector tile search API request
4937- * with a <code>grid_agg</code> argument of <code>geotile</code> and an
4938- * <code>exact_bounds</code> argument of <code>true</code> into the following
4939- * search
4940- *
4941- * <pre>
4942- * <code>GET my-index/_search
4943- * {
4944- * "size": 10000,
4945- * "query": {
4946- * "geo_bounding_box": {
4947- * "my-geo-field": {
4948- * "top_left": {
4949- * "lat": -40.979898069620134,
4950- * "lon": -45
4951- * },
4952- * "bottom_right": {
4953- * "lat": -66.51326044311186,
4954- * "lon": 0
4955- * }
4956- * }
4957- * }
4958- * },
4959- * "aggregations": {
4960- * "grid": {
4961- * "geotile_grid": {
4962- * "field": "my-geo-field",
4963- * "precision": 11,
4964- * "size": 65536,
4965- * "bounds": {
4966- * "top_left": {
4967- * "lat": -40.979898069620134,
4968- * "lon": -45
4969- * },
4970- * "bottom_right": {
4971- * "lat": -66.51326044311186,
4972- * "lon": 0
4973- * }
4974- * }
4975- * }
4976- * },
4977- * "bounds": {
4978- * "geo_bounds": {
4979- * "field": "my-geo-field",
4980- * "wrap_longitude": false
4981- * }
4982- * }
4983- * }
4984- * }
4985- * </code>
4986- * </pre>
4987- * <p>
49884936 * The API returns results as a binary Mapbox vector tile. Mapbox vector tiles
49894937 * are encoded as Google Protobufs (PBF). By default, the tile contains three
49904938 * layers:
@@ -5264,6 +5212,11 @@ public final <TDocument> CompletableFuture<SearchResponse<TDocument>> search(
52645212 * each resolution with the average density of tile bins at each zoom level.
52655213 * Elasticsearch uses the H3 resolution that is closest to the corresponding
52665214 * geotile density.
5215+ * <p>
5216+ * Learn how to use the vector tile search API with practical examples in the
5217+ * <a href=
5218+ * "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/vector-tile-search">Vector
5219+ * tile search examples</a> guide.
52675220 *
52685221 * @see <a href=
52695222 * "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-mvt">Documentation
@@ -5304,58 +5257,6 @@ public CompletableFuture<BinaryResponse> searchMvt(SearchMvtRequest request) {
53045257 * labels, so that, for example, multi-polygons will have only one label.</li>
53055258 * </ul>
53065259 * <p>
5307- * For example, Elasticsearch may translate a vector tile search API request
5308- * with a <code>grid_agg</code> argument of <code>geotile</code> and an
5309- * <code>exact_bounds</code> argument of <code>true</code> into the following
5310- * search
5311- *
5312- * <pre>
5313- * <code>GET my-index/_search
5314- * {
5315- * "size": 10000,
5316- * "query": {
5317- * "geo_bounding_box": {
5318- * "my-geo-field": {
5319- * "top_left": {
5320- * "lat": -40.979898069620134,
5321- * "lon": -45
5322- * },
5323- * "bottom_right": {
5324- * "lat": -66.51326044311186,
5325- * "lon": 0
5326- * }
5327- * }
5328- * }
5329- * },
5330- * "aggregations": {
5331- * "grid": {
5332- * "geotile_grid": {
5333- * "field": "my-geo-field",
5334- * "precision": 11,
5335- * "size": 65536,
5336- * "bounds": {
5337- * "top_left": {
5338- * "lat": -40.979898069620134,
5339- * "lon": -45
5340- * },
5341- * "bottom_right": {
5342- * "lat": -66.51326044311186,
5343- * "lon": 0
5344- * }
5345- * }
5346- * }
5347- * },
5348- * "bounds": {
5349- * "geo_bounds": {
5350- * "field": "my-geo-field",
5351- * "wrap_longitude": false
5352- * }
5353- * }
5354- * }
5355- * }
5356- * </code>
5357- * </pre>
5358- * <p>
53595260 * The API returns results as a binary Mapbox vector tile. Mapbox vector tiles
53605261 * are encoded as Google Protobufs (PBF). By default, the tile contains three
53615262 * layers:
@@ -5635,6 +5536,11 @@ public CompletableFuture<BinaryResponse> searchMvt(SearchMvtRequest request) {
56355536 * each resolution with the average density of tile bins at each zoom level.
56365537 * Elasticsearch uses the H3 resolution that is closest to the corresponding
56375538 * geotile density.
5539+ * <p>
5540+ * Learn how to use the vector tile search API with practical examples in the
5541+ * <a href=
5542+ * "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/vector-tile-search">Vector
5543+ * tile search examples</a> guide.
56385544 *
56395545 * @param fn
56405546 * a function that initializes a builder to create the
@@ -6039,7 +5945,8 @@ public final <TDocument> CompletableFuture<TermvectorsResponse> termvectors(
60395945 * to <code>_source</code>, you can access the following variables through the
60405946 * <code>ctx</code> map: <code>_index</code>, <code>_type</code>,
60415947 * <code>_id</code>, <code>_version</code>, <code>_routing</code>, and
6042- * <code>_now</code> (the current timestamp).
5948+ * <code>_now</code> (the current timestamp). For usage examples such as partial
5949+ * updates, upserts, and scripted updates, see the External documentation.
60435950 *
60445951 * @see <a href=
60455952 * "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-update">Documentation
@@ -6083,7 +5990,8 @@ public <TDocument, TPartialDocument> CompletableFuture<UpdateResponse<TDocument>
60835990 * to <code>_source</code>, you can access the following variables through the
60845991 * <code>ctx</code> map: <code>_index</code>, <code>_type</code>,
60855992 * <code>_id</code>, <code>_version</code>, <code>_routing</code>, and
6086- * <code>_now</code> (the current timestamp).
5993+ * <code>_now</code> (the current timestamp). For usage examples such as partial
5994+ * updates, upserts, and scripted updates, see the External documentation.
60875995 *
60885996 * @param fn
60895997 * a function that initializes a builder to create the
@@ -6126,7 +6034,8 @@ public final <TDocument, TPartialDocument> CompletableFuture<UpdateResponse<TDoc
61266034 * to <code>_source</code>, you can access the following variables through the
61276035 * <code>ctx</code> map: <code>_index</code>, <code>_type</code>,
61286036 * <code>_id</code>, <code>_version</code>, <code>_routing</code>, and
6129- * <code>_now</code> (the current timestamp).
6037+ * <code>_now</code> (the current timestamp). For usage examples such as partial
6038+ * updates, upserts, and scripted updates, see the External documentation.
61306039 *
61316040 * @see <a href=
61326041 * "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-update">Documentation
@@ -6170,7 +6079,8 @@ public <TDocument, TPartialDocument> CompletableFuture<UpdateResponse<TDocument>
61706079 * to <code>_source</code>, you can access the following variables through the
61716080 * <code>ctx</code> map: <code>_index</code>, <code>_type</code>,
61726081 * <code>_id</code>, <code>_version</code>, <code>_routing</code>, and
6173- * <code>_now</code> (the current timestamp).
6082+ * <code>_now</code> (the current timestamp). For usage examples such as partial
6083+ * updates, upserts, and scripted updates, see the External documentation.
61746084 *
61756085 * @param fn
61766086 * a function that initializes a builder to create the
@@ -6228,6 +6138,34 @@ public final <TDocument, TPartialDocument> CompletableFuture<UpdateResponse<TDoc
62286138 * are shown in the response. Any update requests that completed successfully
62296139 * still stick, they are not rolled back.
62306140 * <p>
6141+ * <strong>Refreshing shards</strong>
6142+ * <p>
6143+ * Specifying the <code>refresh</code> parameter refreshes all shards once the
6144+ * request completes. This is different to the update API's <code>refresh</code>
6145+ * parameter, which causes only the shard that received the request to be
6146+ * refreshed. Unlike the update API, it does not support <code>wait_for</code>.
6147+ * <p>
6148+ * <strong>Running update by query asynchronously</strong>
6149+ * <p>
6150+ * If the request contains <code>wait_for_completion=false</code>, Elasticsearch
6151+ * performs some preflight checks, launches the request, and returns a <a href=
6152+ * "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks">task</a>
6153+ * you can use to cancel or get the status of the task. Elasticsearch creates a
6154+ * record of this task as a document at <code>.tasks/task/${taskId}</code>.
6155+ * <p>
6156+ * <strong>Waiting for active shards</strong>
6157+ * <p>
6158+ * <code>wait_for_active_shards</code> controls how many copies of a shard must
6159+ * be active before proceeding with the request. See <a href=
6160+ * "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-create#operation-create-wait_for_active_shards"><code>wait_for_active_shards</code></a>
6161+ * for details. <code>timeout</code> controls how long each write request waits
6162+ * for unavailable shards to become available. Both work exactly the way they
6163+ * work in the <a href=
6164+ * "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-bulk">Bulk
6165+ * API</a>. Update by query uses scrolled searches, so you can also specify the
6166+ * <code>scroll</code> parameter to control how long it keeps the search context
6167+ * alive, for example <code>?scroll=10m</code>. The default is 5 minutes.
6168+ * <p>
62316169 * <strong>Throttling update requests</strong>
62326170 * <p>
62336171 * To control the rate at which update by query issues batches of update
@@ -6305,27 +6243,9 @@ public final <TDocument, TPartialDocument> CompletableFuture<UpdateResponse<TDoc
63056243 * </ul>
63066244 * <p>
63076245 * Whether query or update performance dominates the runtime depends on the
6308- * documents being reindexed and cluster resources.
6309- * <p>
6310- * <strong>Update the document source</strong>
6311- * <p>
6312- * Update by query supports scripts to update the document source. As with the
6313- * update API, you can set <code>ctx.op</code> to change the operation that is
6314- * performed.
6315- * <p>
6316- * Set <code>ctx.op = "noop"</code> if your script decides that it
6317- * doesn't have to make any changes. The update by query operation skips
6318- * updating the document and increments the <code>noop</code> counter.
6319- * <p>
6320- * Set <code>ctx.op = "delete"</code> if your script decides that the
6321- * document should be deleted. The update by query operation deletes the
6322- * document and increments the <code>deleted</code> counter.
6323- * <p>
6324- * Update by query supports only <code>index</code>, <code>noop</code>, and
6325- * <code>delete</code>. Setting <code>ctx.op</code> to anything else is an
6326- * error. Setting any other field in <code>ctx</code> is an error. This API
6327- * enables you to only modify the source of matching documents; you cannot move
6328- * them.
6246+ * documents being reindexed and cluster resources. Refer to the linked
6247+ * documentation for examples of how to update documents using the
6248+ * <code>_update_by_query</code> API:
63296249 *
63306250 * @see <a href=
63316251 * "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-update-by-query">Documentation
@@ -6379,6 +6299,34 @@ public CompletableFuture<UpdateByQueryResponse> updateByQuery(UpdateByQueryReque
63796299 * are shown in the response. Any update requests that completed successfully
63806300 * still stick, they are not rolled back.
63816301 * <p>
6302+ * <strong>Refreshing shards</strong>
6303+ * <p>
6304+ * Specifying the <code>refresh</code> parameter refreshes all shards once the
6305+ * request completes. This is different to the update API's <code>refresh</code>
6306+ * parameter, which causes only the shard that received the request to be
6307+ * refreshed. Unlike the update API, it does not support <code>wait_for</code>.
6308+ * <p>
6309+ * <strong>Running update by query asynchronously</strong>
6310+ * <p>
6311+ * If the request contains <code>wait_for_completion=false</code>, Elasticsearch
6312+ * performs some preflight checks, launches the request, and returns a <a href=
6313+ * "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks">task</a>
6314+ * you can use to cancel or get the status of the task. Elasticsearch creates a
6315+ * record of this task as a document at <code>.tasks/task/${taskId}</code>.
6316+ * <p>
6317+ * <strong>Waiting for active shards</strong>
6318+ * <p>
6319+ * <code>wait_for_active_shards</code> controls how many copies of a shard must
6320+ * be active before proceeding with the request. See <a href=
6321+ * "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-create#operation-create-wait_for_active_shards"><code>wait_for_active_shards</code></a>
6322+ * for details. <code>timeout</code> controls how long each write request waits
6323+ * for unavailable shards to become available. Both work exactly the way they
6324+ * work in the <a href=
6325+ * "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-bulk">Bulk
6326+ * API</a>. Update by query uses scrolled searches, so you can also specify the
6327+ * <code>scroll</code> parameter to control how long it keeps the search context
6328+ * alive, for example <code>?scroll=10m</code>. The default is 5 minutes.
6329+ * <p>
63826330 * <strong>Throttling update requests</strong>
63836331 * <p>
63846332 * To control the rate at which update by query issues batches of update
@@ -6456,27 +6404,9 @@ public CompletableFuture<UpdateByQueryResponse> updateByQuery(UpdateByQueryReque
64566404 * </ul>
64576405 * <p>
64586406 * Whether query or update performance dominates the runtime depends on the
6459- * documents being reindexed and cluster resources.
6460- * <p>
6461- * <strong>Update the document source</strong>
6462- * <p>
6463- * Update by query supports scripts to update the document source. As with the
6464- * update API, you can set <code>ctx.op</code> to change the operation that is
6465- * performed.
6466- * <p>
6467- * Set <code>ctx.op = "noop"</code> if your script decides that it
6468- * doesn't have to make any changes. The update by query operation skips
6469- * updating the document and increments the <code>noop</code> counter.
6470- * <p>
6471- * Set <code>ctx.op = "delete"</code> if your script decides that the
6472- * document should be deleted. The update by query operation deletes the
6473- * document and increments the <code>deleted</code> counter.
6474- * <p>
6475- * Update by query supports only <code>index</code>, <code>noop</code>, and
6476- * <code>delete</code>. Setting <code>ctx.op</code> to anything else is an
6477- * error. Setting any other field in <code>ctx</code> is an error. This API
6478- * enables you to only modify the source of matching documents; you cannot move
6479- * them.
6407+ * documents being reindexed and cluster resources. Refer to the linked
6408+ * documentation for examples of how to update documents using the
6409+ * <code>_update_by_query</code> API:
64806410 *
64816411 * @param fn
64826412 * a function that initializes a builder to create the
0 commit comments