Skip to content

Commit 52df99b

Browse files
committed
[codegen] update to latest spec
1 parent 659ed36 commit 52df99b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+1899
-262
lines changed

java-client/src/main/java/co/elastic/clients/elasticsearch/ElasticsearchAsyncClient.java

Lines changed: 210 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1010,7 +1010,9 @@ public final CompletableFuture<GetScriptResponse> getScript(
10101010
// ----- Endpoint: get_script_context
10111011

10121012
/**
1013-
* Returns all script contexts.
1013+
* Get script contexts.
1014+
* <p>
1015+
* Get a list of supported script contexts and their methods.
10141016
*
10151017
* @see <a href=
10161018
* "https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-contexts.html">Documentation
@@ -1024,7 +1026,9 @@ public CompletableFuture<GetScriptContextResponse> getScriptContext() {
10241026
// ----- Endpoint: get_script_languages
10251027

10261028
/**
1027-
* Returns available script types, languages and contexts
1029+
* Get script languages.
1030+
* <p>
1031+
* Get a list of available script types, languages, and contexts.
10281032
*
10291033
* @see <a href=
10301034
* "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html">Documentation
@@ -1347,7 +1351,27 @@ public final <TDocument> CompletableFuture<MgetResponse<TDocument>> mget(
13471351
// ----- Endpoint: msearch
13481352

13491353
/**
1350-
* Allows to execute several search operations in one request.
1354+
* Run multiple searches.
1355+
* <p>
1356+
* The format of the request is similar to the bulk API format and makes use of
1357+
* the newline delimited JSON (NDJSON) format. The structure is as follows:
1358+
*
1359+
* <pre>
1360+
* <code>header\n
1361+
* body\n
1362+
* header\n
1363+
* body\n
1364+
* </code>
1365+
* </pre>
1366+
* <p>
1367+
* This structure is specifically optimized to reduce parsing if a specific
1368+
* search ends up redirected to another node.
1369+
* <p>
1370+
* IMPORTANT: The final line of data must end with a newline character
1371+
* <code>\n</code>. Each newline character may be preceded by a carriage return
1372+
* <code>\r</code>. When sending requests to this endpoint the
1373+
* <code>Content-Type</code> header should be set to
1374+
* <code>application/x-ndjson</code>.
13511375
*
13521376
* @see <a href=
13531377
* "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html">Documentation
@@ -1365,7 +1389,27 @@ public <TDocument> CompletableFuture<MsearchResponse<TDocument>> msearch(Msearch
13651389
}
13661390

13671391
/**
1368-
* Allows to execute several search operations in one request.
1392+
* Run multiple searches.
1393+
* <p>
1394+
* The format of the request is similar to the bulk API format and makes use of
1395+
* the newline delimited JSON (NDJSON) format. The structure is as follows:
1396+
*
1397+
* <pre>
1398+
* <code>header\n
1399+
* body\n
1400+
* header\n
1401+
* body\n
1402+
* </code>
1403+
* </pre>
1404+
* <p>
1405+
* This structure is specifically optimized to reduce parsing if a specific
1406+
* search ends up redirected to another node.
1407+
* <p>
1408+
* IMPORTANT: The final line of data must end with a newline character
1409+
* <code>\n</code>. Each newline character may be preceded by a carriage return
1410+
* <code>\r</code>. When sending requests to this endpoint the
1411+
* <code>Content-Type</code> header should be set to
1412+
* <code>application/x-ndjson</code>.
13691413
*
13701414
* @param fn
13711415
* a function that initializes a builder to create the
@@ -1381,7 +1425,27 @@ public final <TDocument> CompletableFuture<MsearchResponse<TDocument>> msearch(
13811425
}
13821426

13831427
/**
1384-
* Allows to execute several search operations in one request.
1428+
* Run multiple searches.
1429+
* <p>
1430+
* The format of the request is similar to the bulk API format and makes use of
1431+
* the newline delimited JSON (NDJSON) format. The structure is as follows:
1432+
*
1433+
* <pre>
1434+
* <code>header\n
1435+
* body\n
1436+
* header\n
1437+
* body\n
1438+
* </code>
1439+
* </pre>
1440+
* <p>
1441+
* This structure is specifically optimized to reduce parsing if a specific
1442+
* search ends up redirected to another node.
1443+
* <p>
1444+
* IMPORTANT: The final line of data must end with a newline character
1445+
* <code>\n</code>. Each newline character may be preceded by a carriage return
1446+
* <code>\r</code>. When sending requests to this endpoint the
1447+
* <code>Content-Type</code> header should be set to
1448+
* <code>application/x-ndjson</code>.
13851449
*
13861450
* @see <a href=
13871451
* "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html">Documentation
@@ -1399,7 +1463,27 @@ public <TDocument> CompletableFuture<MsearchResponse<TDocument>> msearch(Msearch
13991463
}
14001464

14011465
/**
1402-
* Allows to execute several search operations in one request.
1466+
* Run multiple searches.
1467+
* <p>
1468+
* The format of the request is similar to the bulk API format and makes use of
1469+
* the newline delimited JSON (NDJSON) format. The structure is as follows:
1470+
*
1471+
* <pre>
1472+
* <code>header\n
1473+
* body\n
1474+
* header\n
1475+
* body\n
1476+
* </code>
1477+
* </pre>
1478+
* <p>
1479+
* This structure is specifically optimized to reduce parsing if a specific
1480+
* search ends up redirected to another node.
1481+
* <p>
1482+
* IMPORTANT: The final line of data must end with a newline character
1483+
* <code>\n</code>. Each newline character may be preceded by a carriage return
1484+
* <code>\r</code>. When sending requests to this endpoint the
1485+
* <code>Content-Type</code> header should be set to
1486+
* <code>application/x-ndjson</code>.
14031487
*
14041488
* @param fn
14051489
* a function that initializes a builder to create the
@@ -1858,7 +1942,29 @@ public final <TResult> CompletableFuture<ScriptsPainlessExecuteResponse<TResult>
18581942
// ----- Endpoint: scroll
18591943

18601944
/**
1861-
* Allows to retrieve a large numbers of results from a single search request.
1945+
* Run a scrolling search.
1946+
* <p>
1947+
* IMPORTANT: The scroll API is no longer recommend for deep pagination. If you
1948+
* need to preserve the index state while paging through more than 10,000 hits,
1949+
* use the <code>search_after</code> parameter with a point in time (PIT).
1950+
* <p>
1951+
* The scroll API gets large sets of results from a single scrolling search
1952+
* request. To get the necessary scroll ID, submit a search API request that
1953+
* includes an argument for the <code>scroll</code> query parameter. The
1954+
* <code>scroll</code> parameter indicates how long Elasticsearch should retain
1955+
* the search context for the request. The search response returns a scroll ID
1956+
* in the <code>_scroll_id</code> response body parameter. You can then use the
1957+
* scroll ID with the scroll API to retrieve the next batch of results for the
1958+
* request. If the Elasticsearch security features are enabled, the access to
1959+
* the results of a specific scroll ID is restricted to the user or API key that
1960+
* submitted the search.
1961+
* <p>
1962+
* You can also use the scroll API to specify a new scroll parameter that
1963+
* extends or shortens the retention period for the search context.
1964+
* <p>
1965+
* IMPORTANT: Results from a scrolling search reflect the state of the index at
1966+
* the time of the initial search request. Subsequent indexing or document
1967+
* changes only affect later search and scroll requests.
18621968
*
18631969
* @see <a href=
18641970
* "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-body.html#request-body-search-scroll">Documentation
@@ -1876,7 +1982,29 @@ public <TDocument> CompletableFuture<ScrollResponse<TDocument>> scroll(ScrollReq
18761982
}
18771983

18781984
/**
1879-
* Allows to retrieve a large numbers of results from a single search request.
1985+
* Run a scrolling search.
1986+
* <p>
1987+
* IMPORTANT: The scroll API is no longer recommend for deep pagination. If you
1988+
* need to preserve the index state while paging through more than 10,000 hits,
1989+
* use the <code>search_after</code> parameter with a point in time (PIT).
1990+
* <p>
1991+
* The scroll API gets large sets of results from a single scrolling search
1992+
* request. To get the necessary scroll ID, submit a search API request that
1993+
* includes an argument for the <code>scroll</code> query parameter. The
1994+
* <code>scroll</code> parameter indicates how long Elasticsearch should retain
1995+
* the search context for the request. The search response returns a scroll ID
1996+
* in the <code>_scroll_id</code> response body parameter. You can then use the
1997+
* scroll ID with the scroll API to retrieve the next batch of results for the
1998+
* request. If the Elasticsearch security features are enabled, the access to
1999+
* the results of a specific scroll ID is restricted to the user or API key that
2000+
* submitted the search.
2001+
* <p>
2002+
* You can also use the scroll API to specify a new scroll parameter that
2003+
* extends or shortens the retention period for the search context.
2004+
* <p>
2005+
* IMPORTANT: Results from a scrolling search reflect the state of the index at
2006+
* the time of the initial search request. Subsequent indexing or document
2007+
* changes only affect later search and scroll requests.
18802008
*
18812009
* @param fn
18822010
* a function that initializes a builder to create the
@@ -1892,7 +2020,29 @@ public final <TDocument> CompletableFuture<ScrollResponse<TDocument>> scroll(
18922020
}
18932021

18942022
/**
1895-
* Allows to retrieve a large numbers of results from a single search request.
2023+
* Run a scrolling search.
2024+
* <p>
2025+
* IMPORTANT: The scroll API is no longer recommend for deep pagination. If you
2026+
* need to preserve the index state while paging through more than 10,000 hits,
2027+
* use the <code>search_after</code> parameter with a point in time (PIT).
2028+
* <p>
2029+
* The scroll API gets large sets of results from a single scrolling search
2030+
* request. To get the necessary scroll ID, submit a search API request that
2031+
* includes an argument for the <code>scroll</code> query parameter. The
2032+
* <code>scroll</code> parameter indicates how long Elasticsearch should retain
2033+
* the search context for the request. The search response returns a scroll ID
2034+
* in the <code>_scroll_id</code> response body parameter. You can then use the
2035+
* scroll ID with the scroll API to retrieve the next batch of results for the
2036+
* request. If the Elasticsearch security features are enabled, the access to
2037+
* the results of a specific scroll ID is restricted to the user or API key that
2038+
* submitted the search.
2039+
* <p>
2040+
* You can also use the scroll API to specify a new scroll parameter that
2041+
* extends or shortens the retention period for the search context.
2042+
* <p>
2043+
* IMPORTANT: Results from a scrolling search reflect the state of the index at
2044+
* the time of the initial search request. Subsequent indexing or document
2045+
* changes only affect later search and scroll requests.
18962046
*
18972047
* @see <a href=
18982048
* "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-body.html#request-body-search-scroll">Documentation
@@ -1909,7 +2059,29 @@ public <TDocument> CompletableFuture<ScrollResponse<TDocument>> scroll(ScrollReq
19092059
}
19102060

19112061
/**
1912-
* Allows to retrieve a large numbers of results from a single search request.
2062+
* Run a scrolling search.
2063+
* <p>
2064+
* IMPORTANT: The scroll API is no longer recommend for deep pagination. If you
2065+
* need to preserve the index state while paging through more than 10,000 hits,
2066+
* use the <code>search_after</code> parameter with a point in time (PIT).
2067+
* <p>
2068+
* The scroll API gets large sets of results from a single scrolling search
2069+
* request. To get the necessary scroll ID, submit a search API request that
2070+
* includes an argument for the <code>scroll</code> query parameter. The
2071+
* <code>scroll</code> parameter indicates how long Elasticsearch should retain
2072+
* the search context for the request. The search response returns a scroll ID
2073+
* in the <code>_scroll_id</code> response body parameter. You can then use the
2074+
* scroll ID with the scroll API to retrieve the next batch of results for the
2075+
* request. If the Elasticsearch security features are enabled, the access to
2076+
* the results of a specific scroll ID is restricted to the user or API key that
2077+
* submitted the search.
2078+
* <p>
2079+
* You can also use the scroll API to specify a new scroll parameter that
2080+
* extends or shortens the retention period for the search context.
2081+
* <p>
2082+
* IMPORTANT: Results from a scrolling search reflect the state of the index at
2083+
* the time of the initial search request. Subsequent indexing or document
2084+
* changes only affect later search and scroll requests.
19132085
*
19142086
* @param fn
19152087
* a function that initializes a builder to create the
@@ -2159,9 +2331,20 @@ public final <TDocument> CompletableFuture<SearchTemplateResponse<TDocument>> se
21592331
// ----- Endpoint: terms_enum
21602332

21612333
/**
2162-
* The terms enum API can be used to discover terms in the index that begin with
2163-
* the provided string. It is designed for low-latency look-ups used in
2164-
* auto-complete scenarios.
2334+
* Get terms in an index.
2335+
* <p>
2336+
* Discover terms that match a partial string in an index. This &quot;terms
2337+
* enum&quot; API is designed for low-latency look-ups used in auto-complete
2338+
* scenarios.
2339+
* <p>
2340+
* If the <code>complete</code> property in the response is false, the returned
2341+
* terms set may be incomplete and should be treated as approximate. This can
2342+
* occur due to a few reasons, such as a request timeout or a node error.
2343+
* <p>
2344+
* NOTE: The terms enum API may return terms from deleted documents. Deleted
2345+
* documents are initially only marked as deleted. It is not until their
2346+
* segments are merged that documents are actually deleted. Until that happens,
2347+
* the terms enum API will return terms from these documents.
21652348
*
21662349
* @see <a href=
21672350
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-terms-enum.html">Documentation
@@ -2176,9 +2359,20 @@ public CompletableFuture<TermsEnumResponse> termsEnum(TermsEnumRequest request)
21762359
}
21772360

21782361
/**
2179-
* The terms enum API can be used to discover terms in the index that begin with
2180-
* the provided string. It is designed for low-latency look-ups used in
2181-
* auto-complete scenarios.
2362+
* Get terms in an index.
2363+
* <p>
2364+
* Discover terms that match a partial string in an index. This &quot;terms
2365+
* enum&quot; API is designed for low-latency look-ups used in auto-complete
2366+
* scenarios.
2367+
* <p>
2368+
* If the <code>complete</code> property in the response is false, the returned
2369+
* terms set may be incomplete and should be treated as approximate. This can
2370+
* occur due to a few reasons, such as a request timeout or a node error.
2371+
* <p>
2372+
* NOTE: The terms enum API may return terms from deleted documents. Deleted
2373+
* documents are initially only marked as deleted. It is not until their
2374+
* segments are merged that documents are actually deleted. Until that happens,
2375+
* the terms enum API will return terms from these documents.
21822376
*
21832377
* @param fn
21842378
* a function that initializes a builder to create the

0 commit comments

Comments
 (0)