Skip to content

Commit

Permalink
[codegen] update to latest spec
Browse files Browse the repository at this point in the history
  • Loading branch information
l-trotta committed Oct 25, 2024
1 parent 659ed36 commit 52df99b
Show file tree
Hide file tree
Showing 49 changed files with 1,899 additions and 262 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -1010,7 +1010,9 @@ public final CompletableFuture<GetScriptResponse> getScript(
// ----- Endpoint: get_script_context

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

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

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

/**
* Allows to execute several search operations in one request.
* Run multiple searches.
* <p>
* The format of the request is similar to the bulk API format and makes use of
* the newline delimited JSON (NDJSON) format. The structure is as follows:
*
* <pre>
* <code>header\n
* body\n
* header\n
* body\n
* </code>
* </pre>
* <p>
* This structure is specifically optimized to reduce parsing if a specific
* search ends up redirected to another node.
* <p>
* IMPORTANT: The final line of data must end with a newline character
* <code>\n</code>. Each newline character may be preceded by a carriage return
* <code>\r</code>. When sending requests to this endpoint the
* <code>Content-Type</code> header should be set to
* <code>application/x-ndjson</code>.
*
* @param fn
* a function that initializes a builder to create the
Expand All @@ -1381,7 +1425,27 @@ public final <TDocument> CompletableFuture<MsearchResponse<TDocument>> msearch(
}

/**
* Allows to execute several search operations in one request.
* Run multiple searches.
* <p>
* The format of the request is similar to the bulk API format and makes use of
* the newline delimited JSON (NDJSON) format. The structure is as follows:
*
* <pre>
* <code>header\n
* body\n
* header\n
* body\n
* </code>
* </pre>
* <p>
* This structure is specifically optimized to reduce parsing if a specific
* search ends up redirected to another node.
* <p>
* IMPORTANT: The final line of data must end with a newline character
* <code>\n</code>. Each newline character may be preceded by a carriage return
* <code>\r</code>. When sending requests to this endpoint the
* <code>Content-Type</code> header should be set to
* <code>application/x-ndjson</code>.
*
* @see <a href=
* "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html">Documentation
Expand All @@ -1399,7 +1463,27 @@ public <TDocument> CompletableFuture<MsearchResponse<TDocument>> msearch(Msearch
}

/**
* Allows to execute several search operations in one request.
* Run multiple searches.
* <p>
* The format of the request is similar to the bulk API format and makes use of
* the newline delimited JSON (NDJSON) format. The structure is as follows:
*
* <pre>
* <code>header\n
* body\n
* header\n
* body\n
* </code>
* </pre>
* <p>
* This structure is specifically optimized to reduce parsing if a specific
* search ends up redirected to another node.
* <p>
* IMPORTANT: The final line of data must end with a newline character
* <code>\n</code>. Each newline character may be preceded by a carriage return
* <code>\r</code>. When sending requests to this endpoint the
* <code>Content-Type</code> header should be set to
* <code>application/x-ndjson</code>.
*
* @param fn
* a function that initializes a builder to create the
Expand Down Expand Up @@ -1858,7 +1942,29 @@ public final <TResult> CompletableFuture<ScriptsPainlessExecuteResponse<TResult>
// ----- Endpoint: scroll

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

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

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

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

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

/**
* The terms enum API can be used to discover terms in the index that begin with
* the provided string. It is designed for low-latency look-ups used in
* auto-complete scenarios.
* Get terms in an index.
* <p>
* Discover terms that match a partial string in an index. This &quot;terms
* enum&quot; API is designed for low-latency look-ups used in auto-complete
* scenarios.
* <p>
* If the <code>complete</code> property in the response is false, the returned
* terms set may be incomplete and should be treated as approximate. This can
* occur due to a few reasons, such as a request timeout or a node error.
* <p>
* NOTE: The terms enum API may return terms from deleted documents. Deleted
* documents are initially only marked as deleted. It is not until their
* segments are merged that documents are actually deleted. Until that happens,
* the terms enum API will return terms from these documents.
*
* @param fn
* a function that initializes a builder to create the
Expand Down
Loading

0 comments on commit 52df99b

Please sign in to comment.