diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ElasticsearchAsyncClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ElasticsearchAsyncClient.java index 01ff4a0d2..6eb25e209 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ElasticsearchAsyncClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ElasticsearchAsyncClient.java @@ -357,7 +357,7 @@ public ElasticsearchXpackAsyncClient xpack() { * increase indexing speed. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-bulk.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-bulk.html">Documentation * on elastic.co</a> */ @@ -377,7 +377,7 @@ public CompletableFuture<BulkResponse> bulk(BulkRequest request) { * a function that initializes a builder to create the * {@link BulkRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-bulk.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-bulk.html">Documentation * on elastic.co</a> */ @@ -391,7 +391,7 @@ public final CompletableFuture<BulkResponse> bulk(Function<BulkRequest.Builder, * increase indexing speed. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-bulk.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-bulk.html">Documentation * on elastic.co</a> */ @@ -406,7 +406,7 @@ public CompletableFuture<BulkResponse> bulk() { * Clears the search context and results for a scrolling search. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/clear-scroll-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/clear-scroll-api.html">Documentation * on elastic.co</a> */ @@ -424,7 +424,7 @@ public CompletableFuture<ClearScrollResponse> clearScroll(ClearScrollRequest req * a function that initializes a builder to create the * {@link ClearScrollRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/clear-scroll-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/clear-scroll-api.html">Documentation * on elastic.co</a> */ @@ -437,7 +437,7 @@ public final CompletableFuture<ClearScrollResponse> clearScroll( * Clears the search context and results for a scrolling search. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/clear-scroll-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/clear-scroll-api.html">Documentation * on elastic.co</a> */ @@ -452,7 +452,7 @@ public CompletableFuture<ClearScrollResponse> clearScroll() { * Closes a point-in-time. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/point-in-time-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/point-in-time-api.html">Documentation * on elastic.co</a> */ @@ -470,7 +470,7 @@ public CompletableFuture<ClosePointInTimeResponse> closePointInTime(ClosePointIn * a function that initializes a builder to create the * {@link ClosePointInTimeRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/point-in-time-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/point-in-time-api.html">Documentation * on elastic.co</a> */ @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -1546,7 +1630,7 @@ public CompletableFuture<MtermvectorsResponse> mtermvectors() { * the more recent point in time. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/point-in-time-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/point-in-time-api.html">Documentation * on elastic.co</a> */ @@ -1571,7 +1655,7 @@ public CompletableFuture<OpenPointInTimeResponse> openPointInTime(OpenPointInTim * a function that initializes a builder to create the * {@link OpenPointInTimeRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/point-in-time-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/point-in-time-api.html">Documentation * on elastic.co</a> */ @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 "terms + * enum" 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 @@ -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 "terms + * enum" 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 diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ElasticsearchClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ElasticsearchClient.java index d2cdc67f7..d3db882c1 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ElasticsearchClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ElasticsearchClient.java @@ -358,7 +358,7 @@ public ElasticsearchXpackClient xpack() { * increase indexing speed. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-bulk.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-bulk.html">Documentation * on elastic.co</a> */ @@ -378,7 +378,7 @@ public BulkResponse bulk(BulkRequest request) throws IOException, ElasticsearchE * a function that initializes a builder to create the * {@link BulkRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-bulk.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-bulk.html">Documentation * on elastic.co</a> */ @@ -393,7 +393,7 @@ public final BulkResponse bulk(Function<BulkRequest.Builder, ObjectBuilder<BulkR * increase indexing speed. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-bulk.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-bulk.html">Documentation * on elastic.co</a> */ @@ -408,7 +408,7 @@ public BulkResponse bulk() throws IOException, ElasticsearchException { * Clears the search context and results for a scrolling search. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/clear-scroll-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/clear-scroll-api.html">Documentation * on elastic.co</a> */ @@ -426,7 +426,7 @@ public ClearScrollResponse clearScroll(ClearScrollRequest request) throws IOExce * a function that initializes a builder to create the * {@link ClearScrollRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/clear-scroll-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/clear-scroll-api.html">Documentation * on elastic.co</a> */ @@ -440,7 +440,7 @@ public final ClearScrollResponse clearScroll( * Clears the search context and results for a scrolling search. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/clear-scroll-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/clear-scroll-api.html">Documentation * on elastic.co</a> */ @@ -455,7 +455,7 @@ public ClearScrollResponse clearScroll() throws IOException, ElasticsearchExcept * Closes a point-in-time. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/point-in-time-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/point-in-time-api.html">Documentation * on elastic.co</a> */ @@ -474,7 +474,7 @@ public ClosePointInTimeResponse closePointInTime(ClosePointInTimeRequest request * a function that initializes a builder to create the * {@link ClosePointInTimeRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/point-in-time-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/point-in-time-api.html">Documentation * on elastic.co</a> */ @@ -1025,7 +1025,9 @@ public final GetScriptResponse getScript(Function<GetScriptRequest.Builder, Obje // ----- 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 @@ -1039,7 +1041,9 @@ public GetScriptContextResponse getScriptContext() throws IOException, Elasticse // ----- 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 @@ -1369,7 +1373,27 @@ public final <TDocument> MgetResponse<TDocument> mget(Function<MgetRequest.Build // ----- 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 @@ -1387,7 +1411,27 @@ public <TDocument> MsearchResponse<TDocument> msearch(MsearchRequest request, Cl } /** - * 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 @@ -1404,7 +1448,27 @@ public final <TDocument> 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 @@ -1422,7 +1486,27 @@ public <TDocument> MsearchResponse<TDocument> msearch(MsearchRequest request, Ty } /** - * 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 @@ -1572,7 +1656,7 @@ public MtermvectorsResponse mtermvectors() throws IOException, ElasticsearchExce * the more recent point in time. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/point-in-time-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/point-in-time-api.html">Documentation * on elastic.co</a> */ @@ -1598,7 +1682,7 @@ public OpenPointInTimeResponse openPointInTime(OpenPointInTimeRequest request) * a function that initializes a builder to create the * {@link OpenPointInTimeRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/point-in-time-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/point-in-time-api.html">Documentation * on elastic.co</a> */ @@ -1891,7 +1975,29 @@ public final <TResult> ScriptsPainlessExecuteResponse<TResult> scriptsPainlessEx // ----- 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 @@ -1909,7 +2015,29 @@ public <TDocument> ScrollResponse<TDocument> scroll(ScrollRequest request, Class } /** - * 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 @@ -1926,7 +2054,29 @@ public final <TDocument> 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 @@ -1944,7 +2094,29 @@ public <TDocument> ScrollResponse<TDocument> scroll(ScrollRequest request, Type } /** - * 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 @@ -2200,9 +2372,20 @@ public final <TDocument> SearchTemplateResponse<TDocument> searchTemplate( // ----- 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 "terms + * enum" 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 @@ -2217,9 +2400,20 @@ public TermsEnumResponse termsEnum(TermsEnumRequest request) throws IOException, } /** - * 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 "terms + * enum" 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 diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/SortOptions.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/SortOptions.java index 4250ba591..80f174715 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/SortOptions.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/SortOptions.java @@ -59,7 +59,7 @@ /** * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/sort-search-results.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/sort-search-results.html">Documentation * on elastic.co</a> * @see <a href="../doc-files/api-spec.html#_types.SortOptions">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/analysis/Normalizer.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/analysis/Normalizer.java index 151d60baa..bedfc1887 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/analysis/Normalizer.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/analysis/Normalizer.java @@ -57,7 +57,7 @@ /** * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/analysis-normalizers.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/analysis-normalizers.html">Documentation * on elastic.co</a> * @see <a href="../../doc-files/api-spec.html#_types.analysis.Normalizer">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/mapping/GeoShapeProperty.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/mapping/GeoShapeProperty.java index 053d9e4e5..af3745cab 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/mapping/GeoShapeProperty.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/mapping/GeoShapeProperty.java @@ -53,7 +53,7 @@ * searching with arbitrary geo shapes such as rectangles and polygons. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/geo-shape.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/geo-shape.html">Documentation * on elastic.co</a> * @see <a href= * "../../doc-files/api-spec.html#_types.mapping.GeoShapeProperty">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/mapping/ShapeProperty.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/mapping/ShapeProperty.java index 0f18305fb..1a8e35f94 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/mapping/ShapeProperty.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/mapping/ShapeProperty.java @@ -54,7 +54,7 @@ * polygons. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/shape.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/shape.html">Documentation * on elastic.co</a> * @see <a href="../../doc-files/api-spec.html#_types.mapping.ShapeProperty">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/query_dsl/Like.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/query_dsl/Like.java index 242c07579..8d65e22d9 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/query_dsl/Like.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/query_dsl/Like.java @@ -60,7 +60,7 @@ * the text. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/query-dsl-mlt-query.html#_document_input_parameters">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/query-dsl-mlt-query.html#_document_input_parameters">Documentation * on elastic.co</a> * @see <a href="../../doc-files/api-spec.html#_types.query_dsl.Like">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/query_dsl/Query.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/query_dsl/Query.java index 8eebcb40f..1103a2dd0 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/query_dsl/Query.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/query_dsl/Query.java @@ -62,9 +62,6 @@ /** * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/query-dsl.html">Documentation - * on elastic.co</a> - * @see <a href= * "../../doc-files/api-spec.html#_types.query_dsl.QueryContainer">API * specification</a> */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/async_search/AsyncSearchStatusRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/async_search/AsyncSearchStatusRequest.java index e66afa4fd..1ca202ca8 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/async_search/AsyncSearchStatusRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/async_search/AsyncSearchStatusRequest.java @@ -56,7 +56,7 @@ // typedef: async_search.status.Request /** - * Get async search status Retrieves the status of a previously submitted async + * Get async search status. Retrieve the status of a previously submitted async * search request given its identifier, without retrieving search results. If * the Elasticsearch security features are enabled, use of this API is * restricted to the <code>monitoring_user</code> role. diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/async_search/DeleteAsyncSearchRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/async_search/DeleteAsyncSearchRequest.java index a9f707561..b6ca9db8f 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/async_search/DeleteAsyncSearchRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/async_search/DeleteAsyncSearchRequest.java @@ -56,12 +56,12 @@ // typedef: async_search.delete.Request /** - * Deletes an async search by identifier. If the search is still running, the - * search request will be cancelled. Otherwise, the saved search results are - * deleted. If the Elasticsearch security features are enabled, the deletion of - * a specific async search is restricted to: the authenticated user that - * submitted the original search request; users that have the - * <code>cancel_task</code> cluster privilege. + * Delete an async search. If the asynchronous search is still running, it is + * cancelled. Otherwise, the saved search results are deleted. If the + * Elasticsearch security features are enabled, the deletion of a specific async + * search is restricted to: the authenticated user that submitted the original + * search request; users that have the <code>cancel_task</code> cluster + * privilege. * * @see <a href="../doc-files/api-spec.html#async_search.delete.Request">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/async_search/ElasticsearchAsyncSearchAsyncClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/async_search/ElasticsearchAsyncSearchAsyncClient.java index 9a008a7c7..f287f6d1e 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/async_search/ElasticsearchAsyncSearchAsyncClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/async_search/ElasticsearchAsyncSearchAsyncClient.java @@ -72,15 +72,15 @@ public ElasticsearchAsyncSearchAsyncClient withTransportOptions(@Nullable Transp // ----- Endpoint: async_search.delete /** - * Deletes an async search by identifier. If the search is still running, the - * search request will be cancelled. Otherwise, the saved search results are - * deleted. If the Elasticsearch security features are enabled, the deletion of - * a specific async search is restricted to: the authenticated user that - * submitted the original search request; users that have the - * <code>cancel_task</code> cluster privilege. + * Delete an async search. If the asynchronous search is still running, it is + * cancelled. Otherwise, the saved search results are deleted. If the + * Elasticsearch security features are enabled, the deletion of a specific async + * search is restricted to: the authenticated user that submitted the original + * search request; users that have the <code>cancel_task</code> cluster + * privilege. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/async-search.html">Documentation * on elastic.co</a> */ @@ -92,18 +92,18 @@ public CompletableFuture<DeleteAsyncSearchResponse> delete(DeleteAsyncSearchRequ } /** - * Deletes an async search by identifier. If the search is still running, the - * search request will be cancelled. Otherwise, the saved search results are - * deleted. If the Elasticsearch security features are enabled, the deletion of - * a specific async search is restricted to: the authenticated user that - * submitted the original search request; users that have the - * <code>cancel_task</code> cluster privilege. + * Delete an async search. If the asynchronous search is still running, it is + * cancelled. Otherwise, the saved search results are deleted. If the + * Elasticsearch security features are enabled, the deletion of a specific async + * search is restricted to: the authenticated user that submitted the original + * search request; users that have the <code>cancel_task</code> cluster + * privilege. * * @param fn * a function that initializes a builder to create the * {@link DeleteAsyncSearchRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/async-search.html">Documentation * on elastic.co</a> */ @@ -115,13 +115,13 @@ public final CompletableFuture<DeleteAsyncSearchResponse> delete( // ----- Endpoint: async_search.get /** - * Retrieves the results of a previously submitted async search request given - * its identifier. If the Elasticsearch security features are enabled, access to - * the results of a specific async search is restricted to the user or API key - * that submitted it. + * Get async search results. Retrieve the results of a previously submitted + * asynchronous search request. If the Elasticsearch security features are + * enabled, access to the results of a specific async search is restricted to + * the user or API key that submitted it. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/async-search.html">Documentation * on elastic.co</a> */ @@ -136,16 +136,16 @@ public <TDocument> CompletableFuture<GetAsyncSearchResponse<TDocument>> get(GetA } /** - * Retrieves the results of a previously submitted async search request given - * its identifier. If the Elasticsearch security features are enabled, access to - * the results of a specific async search is restricted to the user or API key - * that submitted it. + * Get async search results. Retrieve the results of a previously submitted + * asynchronous search request. If the Elasticsearch security features are + * enabled, access to the results of a specific async search is restricted to + * the user or API key that submitted it. * * @param fn * a function that initializes a builder to create the * {@link GetAsyncSearchRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/async-search.html">Documentation * on elastic.co</a> */ @@ -156,13 +156,13 @@ public final <TDocument> CompletableFuture<GetAsyncSearchResponse<TDocument>> ge } /** - * Retrieves the results of a previously submitted async search request given - * its identifier. If the Elasticsearch security features are enabled, access to - * the results of a specific async search is restricted to the user or API key - * that submitted it. + * Get async search results. Retrieve the results of a previously submitted + * asynchronous search request. If the Elasticsearch security features are + * enabled, access to the results of a specific async search is restricted to + * the user or API key that submitted it. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/async-search.html">Documentation * on elastic.co</a> */ @@ -177,16 +177,16 @@ public <TDocument> CompletableFuture<GetAsyncSearchResponse<TDocument>> get(GetA } /** - * Retrieves the results of a previously submitted async search request given - * its identifier. If the Elasticsearch security features are enabled, access to - * the results of a specific async search is restricted to the user or API key - * that submitted it. + * Get async search results. Retrieve the results of a previously submitted + * asynchronous search request. If the Elasticsearch security features are + * enabled, access to the results of a specific async search is restricted to + * the user or API key that submitted it. * * @param fn * a function that initializes a builder to create the * {@link GetAsyncSearchRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/async-search.html">Documentation * on elastic.co</a> */ @@ -198,13 +198,13 @@ public final <TDocument> CompletableFuture<GetAsyncSearchResponse<TDocument>> ge // ----- Endpoint: async_search.status /** - * Get async search status Retrieves the status of a previously submitted async + * Get async search status. Retrieve the status of a previously submitted async * search request given its identifier, without retrieving search results. If * the Elasticsearch security features are enabled, use of this API is * restricted to the <code>monitoring_user</code> role. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/async-search.html">Documentation * on elastic.co</a> */ @@ -216,7 +216,7 @@ public CompletableFuture<AsyncSearchStatusResponse> status(AsyncSearchStatusRequ } /** - * Get async search status Retrieves the status of a previously submitted async + * Get async search status. Retrieve the status of a previously submitted async * search request given its identifier, without retrieving search results. If * the Elasticsearch security features are enabled, use of this API is * restricted to the <code>monitoring_user</code> role. @@ -225,7 +225,7 @@ public CompletableFuture<AsyncSearchStatusResponse> status(AsyncSearchStatusRequ * a function that initializes a builder to create the * {@link AsyncSearchStatusRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/async-search.html">Documentation * on elastic.co</a> */ @@ -237,18 +237,22 @@ public final CompletableFuture<AsyncSearchStatusResponse> status( // ----- Endpoint: async_search.submit /** - * Runs a search request asynchronously. When the primary sort of the results is - * an indexed field, shards get sorted based on minimum and maximum value that - * they hold for that field, hence partial results become available following - * the sort criteria that was requested. Warning: Async search does not support - * scroll nor search requests that only include the suggest section. By default, - * Elasticsearch doesn’t allow you to store an async search response larger than - * 10Mb and an attempt to do this results in an error. The maximum allowed size - * for a stored async search response can be set by changing the - * <code>search.max_async_search_response_size</code> cluster level setting. + * Run an async search. When the primary sort of the results is an indexed + * field, shards get sorted based on minimum and maximum value that they hold + * for that field. Partial results become available following the sort criteria + * that was requested. + * <p> + * Warning: Asynchronous search does not support scroll or search requests that + * include only the suggest section. + * <p> + * By default, Elasticsearch does not allow you to store an async search + * response larger than 10Mb and an attempt to do this results in an error. The + * maximum allowed size for a stored async search response can be set by + * changing the <code>search.max_async_search_response_size</code> cluster level + * setting. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/async-search.html">Documentation * on elastic.co</a> */ @@ -264,21 +268,25 @@ public <TDocument> CompletableFuture<SubmitResponse<TDocument>> submit(SubmitReq } /** - * Runs a search request asynchronously. When the primary sort of the results is - * an indexed field, shards get sorted based on minimum and maximum value that - * they hold for that field, hence partial results become available following - * the sort criteria that was requested. Warning: Async search does not support - * scroll nor search requests that only include the suggest section. By default, - * Elasticsearch doesn’t allow you to store an async search response larger than - * 10Mb and an attempt to do this results in an error. The maximum allowed size - * for a stored async search response can be set by changing the - * <code>search.max_async_search_response_size</code> cluster level setting. + * Run an async search. When the primary sort of the results is an indexed + * field, shards get sorted based on minimum and maximum value that they hold + * for that field. Partial results become available following the sort criteria + * that was requested. + * <p> + * Warning: Asynchronous search does not support scroll or search requests that + * include only the suggest section. + * <p> + * By default, Elasticsearch does not allow you to store an async search + * response larger than 10Mb and an attempt to do this results in an error. The + * maximum allowed size for a stored async search response can be set by + * changing the <code>search.max_async_search_response_size</code> cluster level + * setting. * * @param fn * a function that initializes a builder to create the * {@link SubmitRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/async-search.html">Documentation * on elastic.co</a> */ @@ -288,18 +296,22 @@ public final <TDocument> CompletableFuture<SubmitResponse<TDocument>> submit( } /** - * Runs a search request asynchronously. When the primary sort of the results is - * an indexed field, shards get sorted based on minimum and maximum value that - * they hold for that field, hence partial results become available following - * the sort criteria that was requested. Warning: Async search does not support - * scroll nor search requests that only include the suggest section. By default, - * Elasticsearch doesn’t allow you to store an async search response larger than - * 10Mb and an attempt to do this results in an error. The maximum allowed size - * for a stored async search response can be set by changing the - * <code>search.max_async_search_response_size</code> cluster level setting. + * Run an async search. When the primary sort of the results is an indexed + * field, shards get sorted based on minimum and maximum value that they hold + * for that field. Partial results become available following the sort criteria + * that was requested. + * <p> + * Warning: Asynchronous search does not support scroll or search requests that + * include only the suggest section. + * <p> + * By default, Elasticsearch does not allow you to store an async search + * response larger than 10Mb and an attempt to do this results in an error. The + * maximum allowed size for a stored async search response can be set by + * changing the <code>search.max_async_search_response_size</code> cluster level + * setting. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/async-search.html">Documentation * on elastic.co</a> */ @@ -314,21 +326,25 @@ public <TDocument> CompletableFuture<SubmitResponse<TDocument>> submit(SubmitReq } /** - * Runs a search request asynchronously. When the primary sort of the results is - * an indexed field, shards get sorted based on minimum and maximum value that - * they hold for that field, hence partial results become available following - * the sort criteria that was requested. Warning: Async search does not support - * scroll nor search requests that only include the suggest section. By default, - * Elasticsearch doesn’t allow you to store an async search response larger than - * 10Mb and an attempt to do this results in an error. The maximum allowed size - * for a stored async search response can be set by changing the - * <code>search.max_async_search_response_size</code> cluster level setting. + * Run an async search. When the primary sort of the results is an indexed + * field, shards get sorted based on minimum and maximum value that they hold + * for that field. Partial results become available following the sort criteria + * that was requested. + * <p> + * Warning: Asynchronous search does not support scroll or search requests that + * include only the suggest section. + * <p> + * By default, Elasticsearch does not allow you to store an async search + * response larger than 10Mb and an attempt to do this results in an error. The + * maximum allowed size for a stored async search response can be set by + * changing the <code>search.max_async_search_response_size</code> cluster level + * setting. * * @param fn * a function that initializes a builder to create the * {@link SubmitRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/async-search.html">Documentation * on elastic.co</a> */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/async_search/ElasticsearchAsyncSearchClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/async_search/ElasticsearchAsyncSearchClient.java index aeba7ef78..f3dcedba5 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/async_search/ElasticsearchAsyncSearchClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/async_search/ElasticsearchAsyncSearchClient.java @@ -71,15 +71,15 @@ public ElasticsearchAsyncSearchClient withTransportOptions(@Nullable TransportOp // ----- Endpoint: async_search.delete /** - * Deletes an async search by identifier. If the search is still running, the - * search request will be cancelled. Otherwise, the saved search results are - * deleted. If the Elasticsearch security features are enabled, the deletion of - * a specific async search is restricted to: the authenticated user that - * submitted the original search request; users that have the - * <code>cancel_task</code> cluster privilege. + * Delete an async search. If the asynchronous search is still running, it is + * cancelled. Otherwise, the saved search results are deleted. If the + * Elasticsearch security features are enabled, the deletion of a specific async + * search is restricted to: the authenticated user that submitted the original + * search request; users that have the <code>cancel_task</code> cluster + * privilege. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/async-search.html">Documentation * on elastic.co</a> */ @@ -92,18 +92,18 @@ public DeleteAsyncSearchResponse delete(DeleteAsyncSearchRequest request) } /** - * Deletes an async search by identifier. If the search is still running, the - * search request will be cancelled. Otherwise, the saved search results are - * deleted. If the Elasticsearch security features are enabled, the deletion of - * a specific async search is restricted to: the authenticated user that - * submitted the original search request; users that have the - * <code>cancel_task</code> cluster privilege. + * Delete an async search. If the asynchronous search is still running, it is + * cancelled. Otherwise, the saved search results are deleted. If the + * Elasticsearch security features are enabled, the deletion of a specific async + * search is restricted to: the authenticated user that submitted the original + * search request; users that have the <code>cancel_task</code> cluster + * privilege. * * @param fn * a function that initializes a builder to create the * {@link DeleteAsyncSearchRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/async-search.html">Documentation * on elastic.co</a> */ @@ -116,13 +116,13 @@ public final DeleteAsyncSearchResponse delete( // ----- Endpoint: async_search.get /** - * Retrieves the results of a previously submitted async search request given - * its identifier. If the Elasticsearch security features are enabled, access to - * the results of a specific async search is restricted to the user or API key - * that submitted it. + * Get async search results. Retrieve the results of a previously submitted + * asynchronous search request. If the Elasticsearch security features are + * enabled, access to the results of a specific async search is restricted to + * the user or API key that submitted it. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/async-search.html">Documentation * on elastic.co</a> */ @@ -137,16 +137,16 @@ public <TDocument> GetAsyncSearchResponse<TDocument> get(GetAsyncSearchRequest r } /** - * Retrieves the results of a previously submitted async search request given - * its identifier. If the Elasticsearch security features are enabled, access to - * the results of a specific async search is restricted to the user or API key - * that submitted it. + * Get async search results. Retrieve the results of a previously submitted + * asynchronous search request. If the Elasticsearch security features are + * enabled, access to the results of a specific async search is restricted to + * the user or API key that submitted it. * * @param fn * a function that initializes a builder to create the * {@link GetAsyncSearchRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/async-search.html">Documentation * on elastic.co</a> */ @@ -157,13 +157,13 @@ public final <TDocument> GetAsyncSearchResponse<TDocument> get( } /** - * Retrieves the results of a previously submitted async search request given - * its identifier. If the Elasticsearch security features are enabled, access to - * the results of a specific async search is restricted to the user or API key - * that submitted it. + * Get async search results. Retrieve the results of a previously submitted + * asynchronous search request. If the Elasticsearch security features are + * enabled, access to the results of a specific async search is restricted to + * the user or API key that submitted it. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/async-search.html">Documentation * on elastic.co</a> */ @@ -178,16 +178,16 @@ public <TDocument> GetAsyncSearchResponse<TDocument> get(GetAsyncSearchRequest r } /** - * Retrieves the results of a previously submitted async search request given - * its identifier. If the Elasticsearch security features are enabled, access to - * the results of a specific async search is restricted to the user or API key - * that submitted it. + * Get async search results. Retrieve the results of a previously submitted + * asynchronous search request. If the Elasticsearch security features are + * enabled, access to the results of a specific async search is restricted to + * the user or API key that submitted it. * * @param fn * a function that initializes a builder to create the * {@link GetAsyncSearchRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/async-search.html">Documentation * on elastic.co</a> */ @@ -200,13 +200,13 @@ public final <TDocument> GetAsyncSearchResponse<TDocument> get( // ----- Endpoint: async_search.status /** - * Get async search status Retrieves the status of a previously submitted async + * Get async search status. Retrieve the status of a previously submitted async * search request given its identifier, without retrieving search results. If * the Elasticsearch security features are enabled, use of this API is * restricted to the <code>monitoring_user</code> role. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/async-search.html">Documentation * on elastic.co</a> */ @@ -219,7 +219,7 @@ public AsyncSearchStatusResponse status(AsyncSearchStatusRequest request) } /** - * Get async search status Retrieves the status of a previously submitted async + * Get async search status. Retrieve the status of a previously submitted async * search request given its identifier, without retrieving search results. If * the Elasticsearch security features are enabled, use of this API is * restricted to the <code>monitoring_user</code> role. @@ -228,7 +228,7 @@ public AsyncSearchStatusResponse status(AsyncSearchStatusRequest request) * a function that initializes a builder to create the * {@link AsyncSearchStatusRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/async-search.html">Documentation * on elastic.co</a> */ @@ -241,18 +241,22 @@ public final AsyncSearchStatusResponse status( // ----- Endpoint: async_search.submit /** - * Runs a search request asynchronously. When the primary sort of the results is - * an indexed field, shards get sorted based on minimum and maximum value that - * they hold for that field, hence partial results become available following - * the sort criteria that was requested. Warning: Async search does not support - * scroll nor search requests that only include the suggest section. By default, - * Elasticsearch doesn’t allow you to store an async search response larger than - * 10Mb and an attempt to do this results in an error. The maximum allowed size - * for a stored async search response can be set by changing the - * <code>search.max_async_search_response_size</code> cluster level setting. + * Run an async search. When the primary sort of the results is an indexed + * field, shards get sorted based on minimum and maximum value that they hold + * for that field. Partial results become available following the sort criteria + * that was requested. + * <p> + * Warning: Asynchronous search does not support scroll or search requests that + * include only the suggest section. + * <p> + * By default, Elasticsearch does not allow you to store an async search + * response larger than 10Mb and an attempt to do this results in an error. The + * maximum allowed size for a stored async search response can be set by + * changing the <code>search.max_async_search_response_size</code> cluster level + * setting. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/async-search.html">Documentation * on elastic.co</a> */ @@ -268,21 +272,25 @@ public <TDocument> SubmitResponse<TDocument> submit(SubmitRequest request, Class } /** - * Runs a search request asynchronously. When the primary sort of the results is - * an indexed field, shards get sorted based on minimum and maximum value that - * they hold for that field, hence partial results become available following - * the sort criteria that was requested. Warning: Async search does not support - * scroll nor search requests that only include the suggest section. By default, - * Elasticsearch doesn’t allow you to store an async search response larger than - * 10Mb and an attempt to do this results in an error. The maximum allowed size - * for a stored async search response can be set by changing the - * <code>search.max_async_search_response_size</code> cluster level setting. + * Run an async search. When the primary sort of the results is an indexed + * field, shards get sorted based on minimum and maximum value that they hold + * for that field. Partial results become available following the sort criteria + * that was requested. + * <p> + * Warning: Asynchronous search does not support scroll or search requests that + * include only the suggest section. + * <p> + * By default, Elasticsearch does not allow you to store an async search + * response larger than 10Mb and an attempt to do this results in an error. The + * maximum allowed size for a stored async search response can be set by + * changing the <code>search.max_async_search_response_size</code> cluster level + * setting. * * @param fn * a function that initializes a builder to create the * {@link SubmitRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/async-search.html">Documentation * on elastic.co</a> */ @@ -293,18 +301,22 @@ public final <TDocument> SubmitResponse<TDocument> submit( } /** - * Runs a search request asynchronously. When the primary sort of the results is - * an indexed field, shards get sorted based on minimum and maximum value that - * they hold for that field, hence partial results become available following - * the sort criteria that was requested. Warning: Async search does not support - * scroll nor search requests that only include the suggest section. By default, - * Elasticsearch doesn’t allow you to store an async search response larger than - * 10Mb and an attempt to do this results in an error. The maximum allowed size - * for a stored async search response can be set by changing the - * <code>search.max_async_search_response_size</code> cluster level setting. + * Run an async search. When the primary sort of the results is an indexed + * field, shards get sorted based on minimum and maximum value that they hold + * for that field. Partial results become available following the sort criteria + * that was requested. + * <p> + * Warning: Asynchronous search does not support scroll or search requests that + * include only the suggest section. + * <p> + * By default, Elasticsearch does not allow you to store an async search + * response larger than 10Mb and an attempt to do this results in an error. The + * maximum allowed size for a stored async search response can be set by + * changing the <code>search.max_async_search_response_size</code> cluster level + * setting. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/async-search.html">Documentation * on elastic.co</a> */ @@ -320,21 +332,25 @@ public <TDocument> SubmitResponse<TDocument> submit(SubmitRequest request, Type } /** - * Runs a search request asynchronously. When the primary sort of the results is - * an indexed field, shards get sorted based on minimum and maximum value that - * they hold for that field, hence partial results become available following - * the sort criteria that was requested. Warning: Async search does not support - * scroll nor search requests that only include the suggest section. By default, - * Elasticsearch doesn’t allow you to store an async search response larger than - * 10Mb and an attempt to do this results in an error. The maximum allowed size - * for a stored async search response can be set by changing the - * <code>search.max_async_search_response_size</code> cluster level setting. + * Run an async search. When the primary sort of the results is an indexed + * field, shards get sorted based on minimum and maximum value that they hold + * for that field. Partial results become available following the sort criteria + * that was requested. + * <p> + * Warning: Asynchronous search does not support scroll or search requests that + * include only the suggest section. + * <p> + * By default, Elasticsearch does not allow you to store an async search + * response larger than 10Mb and an attempt to do this results in an error. The + * maximum allowed size for a stored async search response can be set by + * changing the <code>search.max_async_search_response_size</code> cluster level + * setting. * * @param fn * a function that initializes a builder to create the * {@link SubmitRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/async-search.html">Documentation * on elastic.co</a> */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/async_search/GetAsyncSearchRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/async_search/GetAsyncSearchRequest.java index 552819ff4..fbd4cbbd5 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/async_search/GetAsyncSearchRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/async_search/GetAsyncSearchRequest.java @@ -56,10 +56,10 @@ // typedef: async_search.get.Request /** - * Retrieves the results of a previously submitted async search request given - * its identifier. If the Elasticsearch security features are enabled, access to - * the results of a specific async search is restricted to the user or API key - * that submitted it. + * Get async search results. Retrieve the results of a previously submitted + * asynchronous search request. If the Elasticsearch security features are + * enabled, access to the results of a specific async search is restricted to + * the user or API key that submitted it. * * @see <a href="../doc-files/api-spec.html#async_search.get.Request">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/async_search/SubmitRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/async_search/SubmitRequest.java index ba8a2be17..a655d7413 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/async_search/SubmitRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/async_search/SubmitRequest.java @@ -85,15 +85,19 @@ // typedef: async_search.submit.Request /** - * Runs a search request asynchronously. When the primary sort of the results is - * an indexed field, shards get sorted based on minimum and maximum value that - * they hold for that field, hence partial results become available following - * the sort criteria that was requested. Warning: Async search does not support - * scroll nor search requests that only include the suggest section. By default, - * Elasticsearch doesn’t allow you to store an async search response larger than - * 10Mb and an attempt to do this results in an error. The maximum allowed size - * for a stored async search response can be set by changing the - * <code>search.max_async_search_response_size</code> cluster level setting. + * Run an async search. When the primary sort of the results is an indexed + * field, shards get sorted based on minimum and maximum value that they hold + * for that field. Partial results become available following the sort criteria + * that was requested. + * <p> + * Warning: Asynchronous search does not support scroll or search requests that + * include only the suggest section. + * <p> + * By default, Elasticsearch does not allow you to store an async search + * response larger than 10Mb and an attempt to do this results in an error. The + * maximum allowed size for a stored async search response can be set by + * changing the <code>search.max_async_search_response_size</code> cluster level + * setting. * * @see <a href="../doc-files/api-spec.html#async_search.submit.Request">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/autoscaling/ElasticsearchAutoscalingAsyncClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/autoscaling/ElasticsearchAutoscalingAsyncClient.java index d9b55b9bd..b867de1b2 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/autoscaling/ElasticsearchAutoscalingAsyncClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/autoscaling/ElasticsearchAutoscalingAsyncClient.java @@ -74,7 +74,7 @@ public ElasticsearchAutoscalingAsyncClient withTransportOptions(@Nullable Transp * Direct use is not supported. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/autoscaling-delete-autoscaling-policy.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/autoscaling-delete-autoscaling-policy.html">Documentation * on elastic.co</a> */ @@ -94,7 +94,7 @@ public CompletableFuture<DeleteAutoscalingPolicyResponse> deleteAutoscalingPolic * a function that initializes a builder to create the * {@link DeleteAutoscalingPolicyRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/autoscaling-delete-autoscaling-policy.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/autoscaling-delete-autoscaling-policy.html">Documentation * on elastic.co</a> */ @@ -111,7 +111,7 @@ public final CompletableFuture<DeleteAutoscalingPolicyResponse> deleteAutoscalin * supported. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/autoscaling-get-autoscaling-capacity.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/autoscaling-get-autoscaling-capacity.html">Documentation * on elastic.co</a> */ public CompletableFuture<GetAutoscalingCapacityResponse> getAutoscalingCapacity() { @@ -126,7 +126,7 @@ public CompletableFuture<GetAutoscalingCapacityResponse> getAutoscalingCapacity( * ECK. Direct use is not supported. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/autoscaling-get-autoscaling-capacity.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/autoscaling-get-autoscaling-capacity.html">Documentation * on elastic.co</a> */ @@ -145,7 +145,7 @@ public CompletableFuture<GetAutoscalingPolicyResponse> getAutoscalingPolicy(GetA * a function that initializes a builder to create the * {@link GetAutoscalingPolicyRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/autoscaling-get-autoscaling-capacity.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/autoscaling-get-autoscaling-capacity.html">Documentation * on elastic.co</a> */ @@ -161,7 +161,7 @@ public final CompletableFuture<GetAutoscalingPolicyResponse> getAutoscalingPolic * ECK. Direct use is not supported. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/autoscaling-put-autoscaling-policy.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/autoscaling-put-autoscaling-policy.html">Documentation * on elastic.co</a> */ @@ -180,7 +180,7 @@ public CompletableFuture<PutAutoscalingPolicyResponse> putAutoscalingPolicy(PutA * a function that initializes a builder to create the * {@link PutAutoscalingPolicyRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/autoscaling-put-autoscaling-policy.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/autoscaling-put-autoscaling-policy.html">Documentation * on elastic.co</a> */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/autoscaling/ElasticsearchAutoscalingClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/autoscaling/ElasticsearchAutoscalingClient.java index 83a375d12..9b91ac82f 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/autoscaling/ElasticsearchAutoscalingClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/autoscaling/ElasticsearchAutoscalingClient.java @@ -73,7 +73,7 @@ public ElasticsearchAutoscalingClient withTransportOptions(@Nullable TransportOp * Direct use is not supported. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/autoscaling-delete-autoscaling-policy.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/autoscaling-delete-autoscaling-policy.html">Documentation * on elastic.co</a> */ @@ -93,7 +93,7 @@ public DeleteAutoscalingPolicyResponse deleteAutoscalingPolicy(DeleteAutoscaling * a function that initializes a builder to create the * {@link DeleteAutoscalingPolicyRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/autoscaling-delete-autoscaling-policy.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/autoscaling-delete-autoscaling-policy.html">Documentation * on elastic.co</a> */ @@ -111,7 +111,7 @@ public final DeleteAutoscalingPolicyResponse deleteAutoscalingPolicy( * supported. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/autoscaling-get-autoscaling-capacity.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/autoscaling-get-autoscaling-capacity.html">Documentation * on elastic.co</a> */ public GetAutoscalingCapacityResponse getAutoscalingCapacity() throws IOException, ElasticsearchException { @@ -126,7 +126,7 @@ public GetAutoscalingCapacityResponse getAutoscalingCapacity() throws IOExceptio * ECK. Direct use is not supported. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/autoscaling-get-autoscaling-capacity.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/autoscaling-get-autoscaling-capacity.html">Documentation * on elastic.co</a> */ @@ -146,7 +146,7 @@ public GetAutoscalingPolicyResponse getAutoscalingPolicy(GetAutoscalingPolicyReq * a function that initializes a builder to create the * {@link GetAutoscalingPolicyRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/autoscaling-get-autoscaling-capacity.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/autoscaling-get-autoscaling-capacity.html">Documentation * on elastic.co</a> */ @@ -163,7 +163,7 @@ public final GetAutoscalingPolicyResponse getAutoscalingPolicy( * ECK. Direct use is not supported. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/autoscaling-put-autoscaling-policy.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/autoscaling-put-autoscaling-policy.html">Documentation * on elastic.co</a> */ @@ -183,7 +183,7 @@ public PutAutoscalingPolicyResponse putAutoscalingPolicy(PutAutoscalingPolicyReq * a function that initializes a builder to create the * {@link PutAutoscalingPolicyRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/autoscaling-put-autoscaling-policy.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/autoscaling-put-autoscaling-policy.html">Documentation * on elastic.co</a> */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/cat/ElasticsearchCatAsyncClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/cat/ElasticsearchCatAsyncClient.java index b21353b7c..dadde058f 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/cat/ElasticsearchCatAsyncClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/cat/ElasticsearchCatAsyncClient.java @@ -75,7 +75,7 @@ public ElasticsearchCatAsyncClient withTransportOptions(@Nullable TransportOptio * application consumption, use the aliases API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-alias.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-alias.html">Documentation * on elastic.co</a> */ @@ -98,7 +98,7 @@ public CompletableFuture<AliasesResponse> aliases(AliasesRequest request) { * a function that initializes a builder to create the * {@link AliasesRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-alias.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-alias.html">Documentation * on elastic.co</a> */ @@ -116,7 +116,7 @@ public final CompletableFuture<AliasesResponse> aliases( * application consumption, use the aliases API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-alias.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-alias.html">Documentation * on elastic.co</a> */ @@ -134,7 +134,7 @@ public CompletableFuture<AliasesResponse> aliases() { * applications. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-allocation.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-allocation.html">Documentation * on elastic.co</a> */ @@ -155,7 +155,7 @@ public CompletableFuture<AllocationResponse> allocation(AllocationRequest reques * a function that initializes a builder to create the * {@link AllocationRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-allocation.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-allocation.html">Documentation * on elastic.co</a> */ @@ -171,7 +171,7 @@ public final CompletableFuture<AllocationResponse> allocation( * applications. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-allocation.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-allocation.html">Documentation * on elastic.co</a> */ @@ -257,7 +257,7 @@ public CompletableFuture<ComponentTemplatesResponse> componentTemplates() { * application consumption, use the count API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-count.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-count.html">Documentation * on elastic.co</a> */ @@ -282,7 +282,7 @@ public CompletableFuture<CountResponse> count(CountRequest request) { * a function that initializes a builder to create the * {@link CountRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-count.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-count.html">Documentation * on elastic.co</a> */ @@ -302,7 +302,7 @@ public final CompletableFuture<CountResponse> count( * application consumption, use the count API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-count.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-count.html">Documentation * on elastic.co</a> */ @@ -321,7 +321,7 @@ public CompletableFuture<CountResponse> count() { * stats API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-fielddata.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-fielddata.html">Documentation * on elastic.co</a> */ @@ -343,7 +343,7 @@ public CompletableFuture<FielddataResponse> fielddata(FielddataRequest request) * a function that initializes a builder to create the * {@link FielddataRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-fielddata.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-fielddata.html">Documentation * on elastic.co</a> */ @@ -360,7 +360,7 @@ public final CompletableFuture<FielddataResponse> fielddata( * stats API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-fielddata.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-fielddata.html">Documentation * on elastic.co</a> */ @@ -386,7 +386,7 @@ public CompletableFuture<FielddataResponse> fielddata() { * of a large cluster over a longer period of time. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-health.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-health.html">Documentation * on elastic.co</a> */ @@ -415,7 +415,7 @@ public CompletableFuture<HealthResponse> health(HealthRequest request) { * a function that initializes a builder to create the * {@link HealthRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-health.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-health.html">Documentation * on elastic.co</a> */ @@ -439,7 +439,7 @@ public final CompletableFuture<HealthResponse> health( * of a large cluster over a longer period of time. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-health.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-health.html">Documentation * on elastic.co</a> */ @@ -454,7 +454,7 @@ public CompletableFuture<HealthResponse> health() { * Get CAT help. Returns help for the CAT APIs. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat.html">Documentation * on elastic.co</a> */ public CompletableFuture<HelpResponse> help() { @@ -487,7 +487,7 @@ public CompletableFuture<HelpResponse> help() { * application consumption, use an index endpoint. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-indices.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-indices.html">Documentation * on elastic.co</a> */ @@ -525,7 +525,7 @@ public CompletableFuture<IndicesResponse> indices(IndicesRequest request) { * a function that initializes a builder to create the * {@link IndicesRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-indices.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-indices.html">Documentation * on elastic.co</a> */ @@ -558,7 +558,7 @@ public final CompletableFuture<IndicesResponse> indices( * application consumption, use an index endpoint. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-indices.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-indices.html">Documentation * on elastic.co</a> */ @@ -576,7 +576,7 @@ public CompletableFuture<IndicesResponse> indices() { * for use by applications. For application consumption, use the nodes info API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-master.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-master.html">Documentation * on elastic.co</a> */ public CompletableFuture<MasterResponse> master() { @@ -595,7 +595,7 @@ public CompletableFuture<MasterResponse> master() { * consumption, use the get data frame analytics jobs statistics API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-dfanalytics.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-dfanalytics.html">Documentation * on elastic.co</a> */ @@ -618,7 +618,7 @@ public CompletableFuture<MlDataFrameAnalyticsResponse> mlDataFrameAnalytics(MlDa * a function that initializes a builder to create the * {@link MlDataFrameAnalyticsRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-dfanalytics.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-dfanalytics.html">Documentation * on elastic.co</a> */ @@ -636,7 +636,7 @@ public final CompletableFuture<MlDataFrameAnalyticsResponse> mlDataFrameAnalytic * consumption, use the get data frame analytics jobs statistics API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-dfanalytics.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-dfanalytics.html">Documentation * on elastic.co</a> */ @@ -659,7 +659,7 @@ public CompletableFuture<MlDataFrameAnalyticsResponse> mlDataFrameAnalytics() { * consumption, use the get datafeed statistics API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-datafeeds.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-datafeeds.html">Documentation * on elastic.co</a> */ @@ -685,7 +685,7 @@ public CompletableFuture<MlDatafeedsResponse> mlDatafeeds(MlDatafeedsRequest req * a function that initializes a builder to create the * {@link MlDatafeedsRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-datafeeds.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-datafeeds.html">Documentation * on elastic.co</a> */ @@ -706,7 +706,7 @@ public final CompletableFuture<MlDatafeedsResponse> mlDatafeeds( * consumption, use the get datafeed statistics API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-datafeeds.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-datafeeds.html">Documentation * on elastic.co</a> */ @@ -729,7 +729,7 @@ public CompletableFuture<MlDatafeedsResponse> mlDatafeeds() { * consumption, use the get anomaly detection job statistics API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-anomaly-detectors.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-anomaly-detectors.html">Documentation * on elastic.co</a> */ @@ -755,7 +755,7 @@ public CompletableFuture<MlJobsResponse> mlJobs(MlJobsRequest request) { * a function that initializes a builder to create the * {@link MlJobsRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-anomaly-detectors.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-anomaly-detectors.html">Documentation * on elastic.co</a> */ @@ -776,7 +776,7 @@ public final CompletableFuture<MlJobsResponse> mlJobs( * consumption, use the get anomaly detection job statistics API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-anomaly-detectors.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-anomaly-detectors.html">Documentation * on elastic.co</a> */ @@ -796,7 +796,7 @@ public CompletableFuture<MlJobsResponse> mlJobs() { * consumption, use the get trained models statistics API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-trained-model.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-trained-model.html">Documentation * on elastic.co</a> */ @@ -819,7 +819,7 @@ public CompletableFuture<MlTrainedModelsResponse> mlTrainedModels(MlTrainedModel * a function that initializes a builder to create the * {@link MlTrainedModelsRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-trained-model.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-trained-model.html">Documentation * on elastic.co</a> */ @@ -837,7 +837,7 @@ public final CompletableFuture<MlTrainedModelsResponse> mlTrainedModels( * consumption, use the get trained models statistics API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-trained-model.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-trained-model.html">Documentation * on elastic.co</a> */ @@ -855,7 +855,7 @@ public CompletableFuture<MlTrainedModelsResponse> mlTrainedModels() { * use the nodes info API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-nodeattrs.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-nodeattrs.html">Documentation * on elastic.co</a> */ public CompletableFuture<NodeattrsResponse> nodeattrs() { @@ -872,7 +872,7 @@ public CompletableFuture<NodeattrsResponse> nodeattrs() { * use the nodes info API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-nodes.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-nodes.html">Documentation * on elastic.co</a> */ @@ -893,7 +893,7 @@ public CompletableFuture<NodesResponse> nodes(NodesRequest request) { * a function that initializes a builder to create the * {@link NodesRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-nodes.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-nodes.html">Documentation * on elastic.co</a> */ @@ -909,7 +909,7 @@ public final CompletableFuture<NodesResponse> nodes( * use the nodes info API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-nodes.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-nodes.html">Documentation * on elastic.co</a> */ @@ -927,7 +927,7 @@ public CompletableFuture<NodesResponse> nodes() { * consumption, use the pending cluster tasks API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-pending-tasks.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-pending-tasks.html">Documentation * on elastic.co</a> */ public CompletableFuture<PendingTasksResponse> pendingTasks() { @@ -944,7 +944,7 @@ public CompletableFuture<PendingTasksResponse> pendingTasks() { * consumption, use the nodes info API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-plugins.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-plugins.html">Documentation * on elastic.co</a> */ public CompletableFuture<PluginsResponse> plugins() { @@ -966,7 +966,7 @@ public CompletableFuture<PluginsResponse> plugins() { * API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-recovery.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-recovery.html">Documentation * on elastic.co</a> */ @@ -992,7 +992,7 @@ public CompletableFuture<RecoveryResponse> recovery(RecoveryRequest request) { * a function that initializes a builder to create the * {@link RecoveryRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-recovery.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-recovery.html">Documentation * on elastic.co</a> */ @@ -1013,7 +1013,7 @@ public final CompletableFuture<RecoveryResponse> recovery( * API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-recovery.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-recovery.html">Documentation * on elastic.co</a> */ @@ -1031,7 +1031,7 @@ public CompletableFuture<RecoveryResponse> recovery() { * the get snapshot repository API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-repositories.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-repositories.html">Documentation * on elastic.co</a> */ public CompletableFuture<RepositoriesResponse> repositories() { @@ -1049,7 +1049,7 @@ public CompletableFuture<RepositoriesResponse> repositories() { * application consumption, use the index segments API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-segments.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-segments.html">Documentation * on elastic.co</a> */ @@ -1071,7 +1071,7 @@ public CompletableFuture<SegmentsResponse> segments(SegmentsRequest request) { * a function that initializes a builder to create the * {@link SegmentsRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-segments.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-segments.html">Documentation * on elastic.co</a> */ @@ -1088,7 +1088,7 @@ public final CompletableFuture<SegmentsResponse> segments( * application consumption, use the index segments API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-segments.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-segments.html">Documentation * on elastic.co</a> */ @@ -1106,7 +1106,7 @@ public CompletableFuture<SegmentsResponse> segments() { * are not intended for use by applications. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-shards.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-shards.html">Documentation * on elastic.co</a> */ @@ -1127,7 +1127,7 @@ public CompletableFuture<ShardsResponse> shards(ShardsRequest request) { * a function that initializes a builder to create the * {@link ShardsRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-shards.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-shards.html">Documentation * on elastic.co</a> */ @@ -1143,7 +1143,7 @@ public final CompletableFuture<ShardsResponse> shards( * are not intended for use by applications. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-shards.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-shards.html">Documentation * on elastic.co</a> */ @@ -1162,7 +1162,7 @@ public CompletableFuture<ShardsResponse> shards() { * application consumption, use the get snapshot API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-snapshots.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-snapshots.html">Documentation * on elastic.co</a> */ @@ -1184,7 +1184,7 @@ public CompletableFuture<SnapshotsResponse> snapshots(SnapshotsRequest request) * a function that initializes a builder to create the * {@link SnapshotsRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-snapshots.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-snapshots.html">Documentation * on elastic.co</a> */ @@ -1201,7 +1201,7 @@ public final CompletableFuture<SnapshotsResponse> snapshots( * application consumption, use the get snapshot API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-snapshots.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-snapshots.html">Documentation * on elastic.co</a> */ @@ -1219,7 +1219,7 @@ public CompletableFuture<SnapshotsResponse> snapshots() { * application consumption, use the task management API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/tasks.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/tasks.html">Documentation * on elastic.co</a> */ @@ -1240,7 +1240,7 @@ public CompletableFuture<TasksResponse> tasks(TasksRequest request) { * a function that initializes a builder to create the * {@link TasksRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/tasks.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/tasks.html">Documentation * on elastic.co</a> */ @@ -1256,7 +1256,7 @@ public final CompletableFuture<TasksResponse> tasks( * application consumption, use the task management API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/tasks.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/tasks.html">Documentation * on elastic.co</a> */ @@ -1275,7 +1275,7 @@ public CompletableFuture<TasksResponse> tasks() { * applications. For application consumption, use the get index template API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-templates.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-templates.html">Documentation * on elastic.co</a> */ @@ -1297,7 +1297,7 @@ public CompletableFuture<TemplatesResponse> templates(TemplatesRequest request) * a function that initializes a builder to create the * {@link TemplatesRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-templates.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-templates.html">Documentation * on elastic.co</a> */ @@ -1314,7 +1314,7 @@ public final CompletableFuture<TemplatesResponse> templates( * applications. For application consumption, use the get index template API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-templates.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-templates.html">Documentation * on elastic.co</a> */ @@ -1333,7 +1333,7 @@ public CompletableFuture<TemplatesResponse> templates() { * application consumption, use the nodes info API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-thread-pool.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-thread-pool.html">Documentation * on elastic.co</a> */ @@ -1355,7 +1355,7 @@ public CompletableFuture<ThreadPoolResponse> threadPool(ThreadPoolRequest reques * a function that initializes a builder to create the * {@link ThreadPoolRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-thread-pool.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-thread-pool.html">Documentation * on elastic.co</a> */ @@ -1372,7 +1372,7 @@ public final CompletableFuture<ThreadPoolResponse> threadPool( * application consumption, use the nodes info API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-thread-pool.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-thread-pool.html">Documentation * on elastic.co</a> */ @@ -1391,7 +1391,7 @@ public CompletableFuture<ThreadPoolResponse> threadPool() { * consumption, use the get transform statistics API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-transforms.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-transforms.html">Documentation * on elastic.co</a> */ @@ -1413,7 +1413,7 @@ public CompletableFuture<TransformsResponse> transforms(TransformsRequest reques * a function that initializes a builder to create the * {@link TransformsRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-transforms.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-transforms.html">Documentation * on elastic.co</a> */ @@ -1430,7 +1430,7 @@ public final CompletableFuture<TransformsResponse> transforms( * consumption, use the get transform statistics API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-transforms.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-transforms.html">Documentation * on elastic.co</a> */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/cat/ElasticsearchCatClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/cat/ElasticsearchCatClient.java index d967f8be0..ce3b0dcf6 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/cat/ElasticsearchCatClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/cat/ElasticsearchCatClient.java @@ -76,7 +76,7 @@ public ElasticsearchCatClient withTransportOptions(@Nullable TransportOptions tr * application consumption, use the aliases API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-alias.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-alias.html">Documentation * on elastic.co</a> */ @@ -99,7 +99,7 @@ public AliasesResponse aliases(AliasesRequest request) throws IOException, Elast * a function that initializes a builder to create the * {@link AliasesRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-alias.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-alias.html">Documentation * on elastic.co</a> */ @@ -117,7 +117,7 @@ public final AliasesResponse aliases(Function<AliasesRequest.Builder, ObjectBuil * application consumption, use the aliases API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-alias.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-alias.html">Documentation * on elastic.co</a> */ @@ -135,7 +135,7 @@ public AliasesResponse aliases() throws IOException, ElasticsearchException { * applications. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-allocation.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-allocation.html">Documentation * on elastic.co</a> */ @@ -156,7 +156,7 @@ public AllocationResponse allocation(AllocationRequest request) throws IOExcepti * a function that initializes a builder to create the * {@link AllocationRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-allocation.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-allocation.html">Documentation * on elastic.co</a> */ @@ -172,7 +172,7 @@ public final AllocationResponse allocation(Function<AllocationRequest.Builder, O * applications. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-allocation.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-allocation.html">Documentation * on elastic.co</a> */ @@ -260,7 +260,7 @@ public ComponentTemplatesResponse componentTemplates() throws IOException, Elast * application consumption, use the count API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-count.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-count.html">Documentation * on elastic.co</a> */ @@ -285,7 +285,7 @@ public CountResponse count(CountRequest request) throws IOException, Elasticsear * a function that initializes a builder to create the * {@link CountRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-count.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-count.html">Documentation * on elastic.co</a> */ @@ -305,7 +305,7 @@ public final CountResponse count(Function<CountRequest.Builder, ObjectBuilder<Co * application consumption, use the count API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-count.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-count.html">Documentation * on elastic.co</a> */ @@ -324,7 +324,7 @@ public CountResponse count() throws IOException, ElasticsearchException { * stats API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-fielddata.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-fielddata.html">Documentation * on elastic.co</a> */ @@ -346,7 +346,7 @@ public FielddataResponse fielddata(FielddataRequest request) throws IOException, * a function that initializes a builder to create the * {@link FielddataRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-fielddata.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-fielddata.html">Documentation * on elastic.co</a> */ @@ -363,7 +363,7 @@ public final FielddataResponse fielddata(Function<FielddataRequest.Builder, Obje * stats API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-fielddata.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-fielddata.html">Documentation * on elastic.co</a> */ @@ -389,7 +389,7 @@ public FielddataResponse fielddata() throws IOException, ElasticsearchException * of a large cluster over a longer period of time. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-health.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-health.html">Documentation * on elastic.co</a> */ @@ -418,7 +418,7 @@ public HealthResponse health(HealthRequest request) throws IOException, Elastics * a function that initializes a builder to create the * {@link HealthRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-health.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-health.html">Documentation * on elastic.co</a> */ @@ -442,7 +442,7 @@ public final HealthResponse health(Function<HealthRequest.Builder, ObjectBuilder * of a large cluster over a longer period of time. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-health.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-health.html">Documentation * on elastic.co</a> */ @@ -457,7 +457,7 @@ public HealthResponse health() throws IOException, ElasticsearchException { * Get CAT help. Returns help for the CAT APIs. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat.html">Documentation * on elastic.co</a> */ public HelpResponse help() throws IOException, ElasticsearchException { @@ -490,7 +490,7 @@ public HelpResponse help() throws IOException, ElasticsearchException { * application consumption, use an index endpoint. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-indices.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-indices.html">Documentation * on elastic.co</a> */ @@ -528,7 +528,7 @@ public IndicesResponse indices(IndicesRequest request) throws IOException, Elast * a function that initializes a builder to create the * {@link IndicesRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-indices.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-indices.html">Documentation * on elastic.co</a> */ @@ -561,7 +561,7 @@ public final IndicesResponse indices(Function<IndicesRequest.Builder, ObjectBuil * application consumption, use an index endpoint. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-indices.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-indices.html">Documentation * on elastic.co</a> */ @@ -579,7 +579,7 @@ public IndicesResponse indices() throws IOException, ElasticsearchException { * for use by applications. For application consumption, use the nodes info API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-master.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-master.html">Documentation * on elastic.co</a> */ public MasterResponse master() throws IOException, ElasticsearchException { @@ -597,7 +597,7 @@ public MasterResponse master() throws IOException, ElasticsearchException { * consumption, use the get data frame analytics jobs statistics API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-dfanalytics.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-dfanalytics.html">Documentation * on elastic.co</a> */ @@ -621,7 +621,7 @@ public MlDataFrameAnalyticsResponse mlDataFrameAnalytics(MlDataFrameAnalyticsReq * a function that initializes a builder to create the * {@link MlDataFrameAnalyticsRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-dfanalytics.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-dfanalytics.html">Documentation * on elastic.co</a> */ @@ -640,7 +640,7 @@ public final MlDataFrameAnalyticsResponse mlDataFrameAnalytics( * consumption, use the get data frame analytics jobs statistics API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-dfanalytics.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-dfanalytics.html">Documentation * on elastic.co</a> */ @@ -663,7 +663,7 @@ public MlDataFrameAnalyticsResponse mlDataFrameAnalytics() throws IOException, E * consumption, use the get datafeed statistics API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-datafeeds.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-datafeeds.html">Documentation * on elastic.co</a> */ @@ -689,7 +689,7 @@ public MlDatafeedsResponse mlDatafeeds(MlDatafeedsRequest request) throws IOExce * a function that initializes a builder to create the * {@link MlDatafeedsRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-datafeeds.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-datafeeds.html">Documentation * on elastic.co</a> */ @@ -711,7 +711,7 @@ public final MlDatafeedsResponse mlDatafeeds( * consumption, use the get datafeed statistics API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-datafeeds.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-datafeeds.html">Documentation * on elastic.co</a> */ @@ -734,7 +734,7 @@ public MlDatafeedsResponse mlDatafeeds() throws IOException, ElasticsearchExcept * consumption, use the get anomaly detection job statistics API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-anomaly-detectors.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-anomaly-detectors.html">Documentation * on elastic.co</a> */ @@ -760,7 +760,7 @@ public MlJobsResponse mlJobs(MlJobsRequest request) throws IOException, Elastics * a function that initializes a builder to create the * {@link MlJobsRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-anomaly-detectors.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-anomaly-detectors.html">Documentation * on elastic.co</a> */ @@ -781,7 +781,7 @@ public final MlJobsResponse mlJobs(Function<MlJobsRequest.Builder, ObjectBuilder * consumption, use the get anomaly detection job statistics API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-anomaly-detectors.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-anomaly-detectors.html">Documentation * on elastic.co</a> */ @@ -801,7 +801,7 @@ public MlJobsResponse mlJobs() throws IOException, ElasticsearchException { * consumption, use the get trained models statistics API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-trained-model.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-trained-model.html">Documentation * on elastic.co</a> */ @@ -825,7 +825,7 @@ public MlTrainedModelsResponse mlTrainedModels(MlTrainedModelsRequest request) * a function that initializes a builder to create the * {@link MlTrainedModelsRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-trained-model.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-trained-model.html">Documentation * on elastic.co</a> */ @@ -844,7 +844,7 @@ public final MlTrainedModelsResponse mlTrainedModels( * consumption, use the get trained models statistics API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-trained-model.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-trained-model.html">Documentation * on elastic.co</a> */ @@ -862,7 +862,7 @@ public MlTrainedModelsResponse mlTrainedModels() throws IOException, Elasticsear * use the nodes info API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-nodeattrs.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-nodeattrs.html">Documentation * on elastic.co</a> */ public NodeattrsResponse nodeattrs() throws IOException, ElasticsearchException { @@ -879,7 +879,7 @@ public NodeattrsResponse nodeattrs() throws IOException, ElasticsearchException * use the nodes info API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-nodes.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-nodes.html">Documentation * on elastic.co</a> */ @@ -900,7 +900,7 @@ public NodesResponse nodes(NodesRequest request) throws IOException, Elasticsear * a function that initializes a builder to create the * {@link NodesRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-nodes.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-nodes.html">Documentation * on elastic.co</a> */ @@ -916,7 +916,7 @@ public final NodesResponse nodes(Function<NodesRequest.Builder, ObjectBuilder<No * use the nodes info API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-nodes.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-nodes.html">Documentation * on elastic.co</a> */ @@ -934,7 +934,7 @@ public NodesResponse nodes() throws IOException, ElasticsearchException { * consumption, use the pending cluster tasks API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-pending-tasks.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-pending-tasks.html">Documentation * on elastic.co</a> */ public PendingTasksResponse pendingTasks() throws IOException, ElasticsearchException { @@ -951,7 +951,7 @@ public PendingTasksResponse pendingTasks() throws IOException, ElasticsearchExce * consumption, use the nodes info API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-plugins.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-plugins.html">Documentation * on elastic.co</a> */ public PluginsResponse plugins() throws IOException, ElasticsearchException { @@ -972,7 +972,7 @@ public PluginsResponse plugins() throws IOException, ElasticsearchException { * API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-recovery.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-recovery.html">Documentation * on elastic.co</a> */ @@ -998,7 +998,7 @@ public RecoveryResponse recovery(RecoveryRequest request) throws IOException, El * a function that initializes a builder to create the * {@link RecoveryRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-recovery.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-recovery.html">Documentation * on elastic.co</a> */ @@ -1019,7 +1019,7 @@ public final RecoveryResponse recovery(Function<RecoveryRequest.Builder, ObjectB * API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-recovery.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-recovery.html">Documentation * on elastic.co</a> */ @@ -1037,7 +1037,7 @@ public RecoveryResponse recovery() throws IOException, ElasticsearchException { * the get snapshot repository API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-repositories.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-repositories.html">Documentation * on elastic.co</a> */ public RepositoriesResponse repositories() throws IOException, ElasticsearchException { @@ -1055,7 +1055,7 @@ public RepositoriesResponse repositories() throws IOException, ElasticsearchExce * application consumption, use the index segments API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-segments.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-segments.html">Documentation * on elastic.co</a> */ @@ -1077,7 +1077,7 @@ public SegmentsResponse segments(SegmentsRequest request) throws IOException, El * a function that initializes a builder to create the * {@link SegmentsRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-segments.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-segments.html">Documentation * on elastic.co</a> */ @@ -1094,7 +1094,7 @@ public final SegmentsResponse segments(Function<SegmentsRequest.Builder, ObjectB * application consumption, use the index segments API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-segments.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-segments.html">Documentation * on elastic.co</a> */ @@ -1112,7 +1112,7 @@ public SegmentsResponse segments() throws IOException, ElasticsearchException { * are not intended for use by applications. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-shards.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-shards.html">Documentation * on elastic.co</a> */ @@ -1133,7 +1133,7 @@ public ShardsResponse shards(ShardsRequest request) throws IOException, Elastics * a function that initializes a builder to create the * {@link ShardsRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-shards.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-shards.html">Documentation * on elastic.co</a> */ @@ -1149,7 +1149,7 @@ public final ShardsResponse shards(Function<ShardsRequest.Builder, ObjectBuilder * are not intended for use by applications. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-shards.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-shards.html">Documentation * on elastic.co</a> */ @@ -1168,7 +1168,7 @@ public ShardsResponse shards() throws IOException, ElasticsearchException { * application consumption, use the get snapshot API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-snapshots.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-snapshots.html">Documentation * on elastic.co</a> */ @@ -1190,7 +1190,7 @@ public SnapshotsResponse snapshots(SnapshotsRequest request) throws IOException, * a function that initializes a builder to create the * {@link SnapshotsRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-snapshots.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-snapshots.html">Documentation * on elastic.co</a> */ @@ -1207,7 +1207,7 @@ public final SnapshotsResponse snapshots(Function<SnapshotsRequest.Builder, Obje * application consumption, use the get snapshot API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-snapshots.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-snapshots.html">Documentation * on elastic.co</a> */ @@ -1225,7 +1225,7 @@ public SnapshotsResponse snapshots() throws IOException, ElasticsearchException * application consumption, use the task management API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/tasks.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/tasks.html">Documentation * on elastic.co</a> */ @@ -1246,7 +1246,7 @@ public TasksResponse tasks(TasksRequest request) throws IOException, Elasticsear * a function that initializes a builder to create the * {@link TasksRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/tasks.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/tasks.html">Documentation * on elastic.co</a> */ @@ -1262,7 +1262,7 @@ public final TasksResponse tasks(Function<TasksRequest.Builder, ObjectBuilder<Ta * application consumption, use the task management API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/tasks.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/tasks.html">Documentation * on elastic.co</a> */ @@ -1281,7 +1281,7 @@ public TasksResponse tasks() throws IOException, ElasticsearchException { * applications. For application consumption, use the get index template API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-templates.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-templates.html">Documentation * on elastic.co</a> */ @@ -1303,7 +1303,7 @@ public TemplatesResponse templates(TemplatesRequest request) throws IOException, * a function that initializes a builder to create the * {@link TemplatesRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-templates.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-templates.html">Documentation * on elastic.co</a> */ @@ -1320,7 +1320,7 @@ public final TemplatesResponse templates(Function<TemplatesRequest.Builder, Obje * applications. For application consumption, use the get index template API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-templates.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-templates.html">Documentation * on elastic.co</a> */ @@ -1339,7 +1339,7 @@ public TemplatesResponse templates() throws IOException, ElasticsearchException * application consumption, use the nodes info API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-thread-pool.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-thread-pool.html">Documentation * on elastic.co</a> */ @@ -1361,7 +1361,7 @@ public ThreadPoolResponse threadPool(ThreadPoolRequest request) throws IOExcepti * a function that initializes a builder to create the * {@link ThreadPoolRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-thread-pool.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-thread-pool.html">Documentation * on elastic.co</a> */ @@ -1378,7 +1378,7 @@ public final ThreadPoolResponse threadPool(Function<ThreadPoolRequest.Builder, O * application consumption, use the nodes info API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-thread-pool.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-thread-pool.html">Documentation * on elastic.co</a> */ @@ -1397,7 +1397,7 @@ public ThreadPoolResponse threadPool() throws IOException, ElasticsearchExceptio * consumption, use the get transform statistics API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-transforms.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-transforms.html">Documentation * on elastic.co</a> */ @@ -1419,7 +1419,7 @@ public TransformsResponse transforms(TransformsRequest request) throws IOExcepti * a function that initializes a builder to create the * {@link TransformsRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-transforms.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-transforms.html">Documentation * on elastic.co</a> */ @@ -1436,7 +1436,7 @@ public final TransformsResponse transforms(Function<TransformsRequest.Builder, O * consumption, use the get transform statistics API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-transforms.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-transforms.html">Documentation * on elastic.co</a> */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/ElasticsearchCcrAsyncClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/ElasticsearchCcrAsyncClient.java index 5a511d617..181007a40 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/ElasticsearchCcrAsyncClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/ElasticsearchCcrAsyncClient.java @@ -70,7 +70,7 @@ public ElasticsearchCcrAsyncClient withTransportOptions(@Nullable TransportOptio * Deletes auto-follow patterns. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-delete-auto-follow-pattern.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-delete-auto-follow-pattern.html">Documentation * on elastic.co</a> */ @@ -89,7 +89,7 @@ public CompletableFuture<DeleteAutoFollowPatternResponse> deleteAutoFollowPatter * a function that initializes a builder to create the * {@link DeleteAutoFollowPatternRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-delete-auto-follow-pattern.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-delete-auto-follow-pattern.html">Documentation * on elastic.co</a> */ @@ -105,7 +105,7 @@ public final CompletableFuture<DeleteAutoFollowPatternResponse> deleteAutoFollow * index. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-put-follow.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-put-follow.html">Documentation * on elastic.co</a> */ @@ -124,7 +124,7 @@ public CompletableFuture<FollowResponse> follow(FollowRequest request) { * a function that initializes a builder to create the * {@link FollowRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-put-follow.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-put-follow.html">Documentation * on elastic.co</a> */ @@ -140,7 +140,7 @@ public final CompletableFuture<FollowResponse> follow( * status for each follower index * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-get-follow-info.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-get-follow-info.html">Documentation * on elastic.co</a> */ @@ -159,7 +159,7 @@ public CompletableFuture<FollowInfoResponse> followInfo(FollowInfoRequest reques * a function that initializes a builder to create the * {@link FollowInfoRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-get-follow-info.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-get-follow-info.html">Documentation * on elastic.co</a> */ @@ -175,7 +175,7 @@ public final CompletableFuture<FollowInfoResponse> followInfo( * associated with each shard for the specified indices. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-get-follow-stats.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-get-follow-stats.html">Documentation * on elastic.co</a> */ @@ -194,7 +194,7 @@ public CompletableFuture<FollowStatsResponse> followStats(FollowStatsRequest req * a function that initializes a builder to create the * {@link FollowStatsRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-get-follow-stats.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-get-follow-stats.html">Documentation * on elastic.co</a> */ @@ -209,7 +209,7 @@ public final CompletableFuture<FollowStatsResponse> followStats( * Removes the follower retention leases from the leader. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-post-forget-follower.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-post-forget-follower.html">Documentation * on elastic.co</a> */ @@ -227,7 +227,7 @@ public CompletableFuture<ForgetFollowerResponse> forgetFollower(ForgetFollowerRe * a function that initializes a builder to create the * {@link ForgetFollowerRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-post-forget-follower.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-post-forget-follower.html">Documentation * on elastic.co</a> */ @@ -243,7 +243,7 @@ public final CompletableFuture<ForgetFollowerResponse> forgetFollower( * pattern collection. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-get-auto-follow-pattern.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-get-auto-follow-pattern.html">Documentation * on elastic.co</a> */ @@ -262,7 +262,7 @@ public CompletableFuture<GetAutoFollowPatternResponse> getAutoFollowPattern(GetA * a function that initializes a builder to create the * {@link GetAutoFollowPatternRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-get-auto-follow-pattern.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-get-auto-follow-pattern.html">Documentation * on elastic.co</a> */ @@ -276,7 +276,7 @@ public final CompletableFuture<GetAutoFollowPatternResponse> getAutoFollowPatter * pattern collection. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-get-auto-follow-pattern.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-get-auto-follow-pattern.html">Documentation * on elastic.co</a> */ @@ -291,7 +291,7 @@ public CompletableFuture<GetAutoFollowPatternResponse> getAutoFollowPattern() { * Pauses an auto-follow pattern * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-pause-auto-follow-pattern.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-pause-auto-follow-pattern.html">Documentation * on elastic.co</a> */ @@ -310,7 +310,7 @@ public CompletableFuture<PauseAutoFollowPatternResponse> pauseAutoFollowPattern( * a function that initializes a builder to create the * {@link PauseAutoFollowPatternRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-pause-auto-follow-pattern.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-pause-auto-follow-pattern.html">Documentation * on elastic.co</a> */ @@ -326,7 +326,7 @@ public final CompletableFuture<PauseAutoFollowPatternResponse> pauseAutoFollowPa * operations from the leader index. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-post-pause-follow.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-post-pause-follow.html">Documentation * on elastic.co</a> */ @@ -345,7 +345,7 @@ public CompletableFuture<PauseFollowResponse> pauseFollow(PauseFollowRequest req * a function that initializes a builder to create the * {@link PauseFollowRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-post-pause-follow.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-post-pause-follow.html">Documentation * on elastic.co</a> */ @@ -362,7 +362,7 @@ public final CompletableFuture<PauseFollowResponse> pauseFollow( * the specified patterns will be automatically configured as follower indices. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-put-auto-follow-pattern.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-put-auto-follow-pattern.html">Documentation * on elastic.co</a> */ @@ -382,7 +382,7 @@ public CompletableFuture<PutAutoFollowPatternResponse> putAutoFollowPattern(PutA * a function that initializes a builder to create the * {@link PutAutoFollowPatternRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-put-auto-follow-pattern.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-put-auto-follow-pattern.html">Documentation * on elastic.co</a> */ @@ -397,7 +397,7 @@ public final CompletableFuture<PutAutoFollowPatternResponse> putAutoFollowPatter * Resumes an auto-follow pattern that has been paused * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-resume-auto-follow-pattern.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-resume-auto-follow-pattern.html">Documentation * on elastic.co</a> */ @@ -416,7 +416,7 @@ public CompletableFuture<ResumeAutoFollowPatternResponse> resumeAutoFollowPatter * a function that initializes a builder to create the * {@link ResumeAutoFollowPatternRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-resume-auto-follow-pattern.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-resume-auto-follow-pattern.html">Documentation * on elastic.co</a> */ @@ -431,7 +431,7 @@ public final CompletableFuture<ResumeAutoFollowPatternResponse> resumeAutoFollow * Resumes a follower index that has been paused * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-post-resume-follow.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-post-resume-follow.html">Documentation * on elastic.co</a> */ @@ -449,7 +449,7 @@ public CompletableFuture<ResumeFollowResponse> resumeFollow(ResumeFollowRequest * a function that initializes a builder to create the * {@link ResumeFollowRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-post-resume-follow.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-post-resume-follow.html">Documentation * on elastic.co</a> */ @@ -464,7 +464,7 @@ public final CompletableFuture<ResumeFollowResponse> resumeFollow( * Gets all stats related to cross-cluster replication. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-get-stats.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-get-stats.html">Documentation * on elastic.co</a> */ public CompletableFuture<CcrStatsResponse> stats() { @@ -479,7 +479,7 @@ public CompletableFuture<CcrStatsResponse> stats() { * metadata and settings associated with cross-cluster replication. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-post-unfollow.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-post-unfollow.html">Documentation * on elastic.co</a> */ @@ -498,7 +498,7 @@ public CompletableFuture<UnfollowResponse> unfollow(UnfollowRequest request) { * a function that initializes a builder to create the * {@link UnfollowRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-post-unfollow.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-post-unfollow.html">Documentation * on elastic.co</a> */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/ElasticsearchCcrClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/ElasticsearchCcrClient.java index 2569bae30..ed3406a46 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/ElasticsearchCcrClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/ElasticsearchCcrClient.java @@ -71,7 +71,7 @@ public ElasticsearchCcrClient withTransportOptions(@Nullable TransportOptions tr * Deletes auto-follow patterns. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-delete-auto-follow-pattern.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-delete-auto-follow-pattern.html">Documentation * on elastic.co</a> */ @@ -90,7 +90,7 @@ public DeleteAutoFollowPatternResponse deleteAutoFollowPattern(DeleteAutoFollowP * a function that initializes a builder to create the * {@link DeleteAutoFollowPatternRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-delete-auto-follow-pattern.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-delete-auto-follow-pattern.html">Documentation * on elastic.co</a> */ @@ -107,7 +107,7 @@ public final DeleteAutoFollowPatternResponse deleteAutoFollowPattern( * index. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-put-follow.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-put-follow.html">Documentation * on elastic.co</a> */ @@ -126,7 +126,7 @@ public FollowResponse follow(FollowRequest request) throws IOException, Elastics * a function that initializes a builder to create the * {@link FollowRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-put-follow.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-put-follow.html">Documentation * on elastic.co</a> */ @@ -142,7 +142,7 @@ public final FollowResponse follow(Function<FollowRequest.Builder, ObjectBuilder * status for each follower index * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-get-follow-info.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-get-follow-info.html">Documentation * on elastic.co</a> */ @@ -161,7 +161,7 @@ public FollowInfoResponse followInfo(FollowInfoRequest request) throws IOExcepti * a function that initializes a builder to create the * {@link FollowInfoRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-get-follow-info.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-get-follow-info.html">Documentation * on elastic.co</a> */ @@ -177,7 +177,7 @@ public final FollowInfoResponse followInfo(Function<FollowInfoRequest.Builder, O * associated with each shard for the specified indices. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-get-follow-stats.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-get-follow-stats.html">Documentation * on elastic.co</a> */ @@ -196,7 +196,7 @@ public FollowStatsResponse followStats(FollowStatsRequest request) throws IOExce * a function that initializes a builder to create the * {@link FollowStatsRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-get-follow-stats.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-get-follow-stats.html">Documentation * on elastic.co</a> */ @@ -212,7 +212,7 @@ public final FollowStatsResponse followStats( * Removes the follower retention leases from the leader. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-post-forget-follower.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-post-forget-follower.html">Documentation * on elastic.co</a> */ @@ -231,7 +231,7 @@ public ForgetFollowerResponse forgetFollower(ForgetFollowerRequest request) * a function that initializes a builder to create the * {@link ForgetFollowerRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-post-forget-follower.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-post-forget-follower.html">Documentation * on elastic.co</a> */ @@ -248,7 +248,7 @@ public final ForgetFollowerResponse forgetFollower( * pattern collection. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-get-auto-follow-pattern.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-get-auto-follow-pattern.html">Documentation * on elastic.co</a> */ @@ -268,7 +268,7 @@ public GetAutoFollowPatternResponse getAutoFollowPattern(GetAutoFollowPatternReq * a function that initializes a builder to create the * {@link GetAutoFollowPatternRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-get-auto-follow-pattern.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-get-auto-follow-pattern.html">Documentation * on elastic.co</a> */ @@ -283,7 +283,7 @@ public final GetAutoFollowPatternResponse getAutoFollowPattern( * pattern collection. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-get-auto-follow-pattern.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-get-auto-follow-pattern.html">Documentation * on elastic.co</a> */ @@ -298,7 +298,7 @@ public GetAutoFollowPatternResponse getAutoFollowPattern() throws IOException, E * Pauses an auto-follow pattern * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-pause-auto-follow-pattern.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-pause-auto-follow-pattern.html">Documentation * on elastic.co</a> */ @@ -317,7 +317,7 @@ public PauseAutoFollowPatternResponse pauseAutoFollowPattern(PauseAutoFollowPatt * a function that initializes a builder to create the * {@link PauseAutoFollowPatternRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-pause-auto-follow-pattern.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-pause-auto-follow-pattern.html">Documentation * on elastic.co</a> */ @@ -334,7 +334,7 @@ public final PauseAutoFollowPatternResponse pauseAutoFollowPattern( * operations from the leader index. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-post-pause-follow.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-post-pause-follow.html">Documentation * on elastic.co</a> */ @@ -353,7 +353,7 @@ public PauseFollowResponse pauseFollow(PauseFollowRequest request) throws IOExce * a function that initializes a builder to create the * {@link PauseFollowRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-post-pause-follow.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-post-pause-follow.html">Documentation * on elastic.co</a> */ @@ -371,7 +371,7 @@ public final PauseFollowResponse pauseFollow( * the specified patterns will be automatically configured as follower indices. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-put-auto-follow-pattern.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-put-auto-follow-pattern.html">Documentation * on elastic.co</a> */ @@ -392,7 +392,7 @@ public PutAutoFollowPatternResponse putAutoFollowPattern(PutAutoFollowPatternReq * a function that initializes a builder to create the * {@link PutAutoFollowPatternRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-put-auto-follow-pattern.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-put-auto-follow-pattern.html">Documentation * on elastic.co</a> */ @@ -408,7 +408,7 @@ public final PutAutoFollowPatternResponse putAutoFollowPattern( * Resumes an auto-follow pattern that has been paused * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-resume-auto-follow-pattern.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-resume-auto-follow-pattern.html">Documentation * on elastic.co</a> */ @@ -427,7 +427,7 @@ public ResumeAutoFollowPatternResponse resumeAutoFollowPattern(ResumeAutoFollowP * a function that initializes a builder to create the * {@link ResumeAutoFollowPatternRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-resume-auto-follow-pattern.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-resume-auto-follow-pattern.html">Documentation * on elastic.co</a> */ @@ -443,7 +443,7 @@ public final ResumeAutoFollowPatternResponse resumeAutoFollowPattern( * Resumes a follower index that has been paused * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-post-resume-follow.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-post-resume-follow.html">Documentation * on elastic.co</a> */ @@ -461,7 +461,7 @@ public ResumeFollowResponse resumeFollow(ResumeFollowRequest request) throws IOE * a function that initializes a builder to create the * {@link ResumeFollowRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-post-resume-follow.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-post-resume-follow.html">Documentation * on elastic.co</a> */ @@ -477,7 +477,7 @@ public final ResumeFollowResponse resumeFollow( * Gets all stats related to cross-cluster replication. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-get-stats.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-get-stats.html">Documentation * on elastic.co</a> */ public CcrStatsResponse stats() throws IOException, ElasticsearchException { @@ -492,7 +492,7 @@ public CcrStatsResponse stats() throws IOException, ElasticsearchException { * metadata and settings associated with cross-cluster replication. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-post-unfollow.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-post-unfollow.html">Documentation * on elastic.co</a> */ @@ -511,7 +511,7 @@ public UnfollowResponse unfollow(UnfollowRequest request) throws IOException, El * a function that initializes a builder to create the * {@link UnfollowRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-post-unfollow.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-post-unfollow.html">Documentation * on elastic.co</a> */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ElasticsearchClusterAsyncClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ElasticsearchClusterAsyncClient.java index 909dcab4f..12b3a5078 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ElasticsearchClusterAsyncClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ElasticsearchClusterAsyncClient.java @@ -74,7 +74,7 @@ public ElasticsearchClusterAsyncClient withTransportOptions(@Nullable TransportO * Provides explanations for shard allocations in the cluster. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-allocation-explain.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-allocation-explain.html">Documentation * on elastic.co</a> */ @@ -92,7 +92,7 @@ public CompletableFuture<AllocationExplainResponse> allocationExplain(Allocation * a function that initializes a builder to create the * {@link AllocationExplainRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-allocation-explain.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-allocation-explain.html">Documentation * on elastic.co</a> */ @@ -105,7 +105,7 @@ public final CompletableFuture<AllocationExplainResponse> allocationExplain( * Provides explanations for shard allocations in the cluster. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-allocation-explain.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-allocation-explain.html">Documentation * on elastic.co</a> */ @@ -122,7 +122,7 @@ public CompletableFuture<AllocationExplainResponse> allocationExplain() { * mappings, settings, and aliases. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-component-template.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-component-template.html">Documentation * on elastic.co</a> */ @@ -143,7 +143,7 @@ public CompletableFuture<DeleteComponentTemplateResponse> deleteComponentTemplat * a function that initializes a builder to create the * {@link DeleteComponentTemplateRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-component-template.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-component-template.html">Documentation * on elastic.co</a> */ @@ -158,7 +158,7 @@ public final CompletableFuture<DeleteComponentTemplateResponse> deleteComponentT * Clears cluster voting config exclusions. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/voting-config-exclusions.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/voting-config-exclusions.html">Documentation * on elastic.co</a> */ @@ -177,7 +177,7 @@ public CompletableFuture<BooleanResponse> deleteVotingConfigExclusions( * a function that initializes a builder to create the * {@link DeleteVotingConfigExclusionsRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/voting-config-exclusions.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/voting-config-exclusions.html">Documentation * on elastic.co</a> */ @@ -190,7 +190,7 @@ public final CompletableFuture<BooleanResponse> deleteVotingConfigExclusions( * Clears cluster voting config exclusions. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/voting-config-exclusions.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/voting-config-exclusions.html">Documentation * on elastic.co</a> */ @@ -206,7 +206,7 @@ public CompletableFuture<BooleanResponse> deleteVotingConfigExclusions() { * component template exists. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-component-template.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-component-template.html">Documentation * on elastic.co</a> */ @@ -225,7 +225,7 @@ public CompletableFuture<BooleanResponse> existsComponentTemplate(ExistsComponen * a function that initializes a builder to create the * {@link ExistsComponentTemplateRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-component-template.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-component-template.html">Documentation * on elastic.co</a> */ @@ -240,7 +240,7 @@ public final CompletableFuture<BooleanResponse> existsComponentTemplate( * Get component templates. Retrieves information about component templates. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-component-template.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-component-template.html">Documentation * on elastic.co</a> */ @@ -258,7 +258,7 @@ public CompletableFuture<GetComponentTemplateResponse> getComponentTemplate(GetC * a function that initializes a builder to create the * {@link GetComponentTemplateRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-component-template.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-component-template.html">Documentation * on elastic.co</a> */ @@ -271,7 +271,7 @@ public final CompletableFuture<GetComponentTemplateResponse> getComponentTemplat * Get component templates. Retrieves information about component templates. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-component-template.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-component-template.html">Documentation * on elastic.co</a> */ @@ -287,7 +287,7 @@ public CompletableFuture<GetComponentTemplateResponse> getComponentTemplate() { * been explicitly defined. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-get-settings.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-get-settings.html">Documentation * on elastic.co</a> */ @@ -306,7 +306,7 @@ public CompletableFuture<GetClusterSettingsResponse> getSettings(GetClusterSetti * a function that initializes a builder to create the * {@link GetClusterSettingsRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-get-settings.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-get-settings.html">Documentation * on elastic.co</a> */ @@ -320,7 +320,7 @@ public final CompletableFuture<GetClusterSettingsResponse> getSettings( * been explicitly defined. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-get-settings.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-get-settings.html">Documentation * on elastic.co</a> */ @@ -343,7 +343,7 @@ public CompletableFuture<GetClusterSettingsResponse> getSettings() { * The cluster status is controlled by the worst index status. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-health.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-health.html">Documentation * on elastic.co</a> */ @@ -369,7 +369,7 @@ public CompletableFuture<HealthResponse> health(HealthRequest request) { * a function that initializes a builder to create the * {@link HealthRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-health.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-health.html">Documentation * on elastic.co</a> */ @@ -390,7 +390,7 @@ public final CompletableFuture<HealthResponse> health( * The cluster status is controlled by the worst index status. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-health.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-health.html">Documentation * on elastic.co</a> */ @@ -405,7 +405,7 @@ public CompletableFuture<HealthResponse> health() { * Get cluster info. Returns basic information about the cluster. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-info.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-info.html">Documentation * on elastic.co</a> */ @@ -423,7 +423,7 @@ public CompletableFuture<ClusterInfoResponse> info(ClusterInfoRequest request) { * a function that initializes a builder to create the * {@link ClusterInfoRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-info.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-info.html">Documentation * on elastic.co</a> */ @@ -445,7 +445,7 @@ public final CompletableFuture<ClusterInfoResponse> info( * reported by both task api and pending cluster tasks API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-pending.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-pending.html">Documentation * on elastic.co</a> */ @@ -470,7 +470,7 @@ public CompletableFuture<PendingTasksResponse> pendingTasks(PendingTasksRequest * a function that initializes a builder to create the * {@link PendingTasksRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-pending.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-pending.html">Documentation * on elastic.co</a> */ @@ -490,7 +490,7 @@ public final CompletableFuture<PendingTasksResponse> pendingTasks( * reported by both task api and pending cluster tasks API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-pending.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-pending.html">Documentation * on elastic.co</a> */ @@ -505,7 +505,7 @@ public CompletableFuture<PendingTasksResponse> pendingTasks() { * Updates the cluster voting config exclusions by node ids or node names. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/voting-config-exclusions.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/voting-config-exclusions.html">Documentation * on elastic.co</a> */ @@ -523,7 +523,7 @@ public CompletableFuture<BooleanResponse> postVotingConfigExclusions(PostVotingC * a function that initializes a builder to create the * {@link PostVotingConfigExclusionsRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/voting-config-exclusions.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/voting-config-exclusions.html">Documentation * on elastic.co</a> */ @@ -536,7 +536,7 @@ public final CompletableFuture<BooleanResponse> postVotingConfigExclusions( * Updates the cluster voting config exclusions by node ids or node names. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/voting-config-exclusions.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/voting-config-exclusions.html">Documentation * on elastic.co</a> */ @@ -571,7 +571,7 @@ public CompletableFuture<BooleanResponse> postVotingConfigExclusions() { * before the opening curly bracket. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-component-template.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-component-template.html">Documentation * on elastic.co</a> */ @@ -609,7 +609,7 @@ public CompletableFuture<PutComponentTemplateResponse> putComponentTemplate(PutC * a function that initializes a builder to create the * {@link PutComponentTemplateRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-component-template.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-component-template.html">Documentation * on elastic.co</a> */ @@ -624,7 +624,7 @@ public final CompletableFuture<PutComponentTemplateResponse> putComponentTemplat * Updates the cluster settings. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-update-settings.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-update-settings.html">Documentation * on elastic.co</a> */ @@ -642,7 +642,7 @@ public CompletableFuture<PutClusterSettingsResponse> putSettings(PutClusterSetti * a function that initializes a builder to create the * {@link PutClusterSettingsRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-update-settings.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-update-settings.html">Documentation * on elastic.co</a> */ @@ -655,7 +655,7 @@ public final CompletableFuture<PutClusterSettingsResponse> putSettings( * Updates the cluster settings. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-update-settings.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-update-settings.html">Documentation * on elastic.co</a> */ @@ -672,7 +672,7 @@ public CompletableFuture<PutClusterSettingsResponse> putSettings() { * keyed by the configured remote cluster alias. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-remote-info.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-remote-info.html">Documentation * on elastic.co</a> */ public CompletableFuture<RemoteInfoResponse> remoteInfo() { @@ -686,7 +686,7 @@ public CompletableFuture<RemoteInfoResponse> remoteInfo() { * Allows to manually change the allocation of individual shards in the cluster. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-reroute.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-reroute.html">Documentation * on elastic.co</a> */ @@ -704,7 +704,7 @@ public CompletableFuture<RerouteResponse> reroute(RerouteRequest request) { * a function that initializes a builder to create the * {@link RerouteRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-reroute.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-reroute.html">Documentation * on elastic.co</a> */ @@ -717,7 +717,7 @@ public final CompletableFuture<RerouteResponse> reroute( * Allows to manually change the allocation of individual shards in the cluster. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-reroute.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-reroute.html">Documentation * on elastic.co</a> */ @@ -732,7 +732,7 @@ public CompletableFuture<RerouteResponse> reroute() { * Returns a comprehensive information about the state of the cluster. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-state.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-state.html">Documentation * on elastic.co</a> */ @@ -750,7 +750,7 @@ public CompletableFuture<StateResponse> state(StateRequest request) { * a function that initializes a builder to create the * {@link StateRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-state.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-state.html">Documentation * on elastic.co</a> */ @@ -763,7 +763,7 @@ public final CompletableFuture<StateResponse> state( * Returns a comprehensive information about the state of the cluster. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-state.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-state.html">Documentation * on elastic.co</a> */ @@ -781,7 +781,7 @@ public CompletableFuture<StateResponse> state() { * plugins). * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-stats.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-stats.html">Documentation * on elastic.co</a> */ @@ -802,7 +802,7 @@ public CompletableFuture<ClusterStatsResponse> stats(ClusterStatsRequest request * a function that initializes a builder to create the * {@link ClusterStatsRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-stats.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-stats.html">Documentation * on elastic.co</a> */ @@ -818,7 +818,7 @@ public final CompletableFuture<ClusterStatsResponse> stats( * plugins). * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-stats.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-stats.html">Documentation * on elastic.co</a> */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ElasticsearchClusterClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ElasticsearchClusterClient.java index fb95a3f23..767e17092 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ElasticsearchClusterClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ElasticsearchClusterClient.java @@ -72,7 +72,7 @@ public ElasticsearchClusterClient withTransportOptions(@Nullable TransportOption * Provides explanations for shard allocations in the cluster. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-allocation-explain.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-allocation-explain.html">Documentation * on elastic.co</a> */ @@ -91,7 +91,7 @@ public AllocationExplainResponse allocationExplain(AllocationExplainRequest requ * a function that initializes a builder to create the * {@link AllocationExplainRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-allocation-explain.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-allocation-explain.html">Documentation * on elastic.co</a> */ @@ -105,7 +105,7 @@ public final AllocationExplainResponse allocationExplain( * Provides explanations for shard allocations in the cluster. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-allocation-explain.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-allocation-explain.html">Documentation * on elastic.co</a> */ @@ -122,7 +122,7 @@ public AllocationExplainResponse allocationExplain() throws IOException, Elastic * mappings, settings, and aliases. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-component-template.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-component-template.html">Documentation * on elastic.co</a> */ @@ -143,7 +143,7 @@ public DeleteComponentTemplateResponse deleteComponentTemplate(DeleteComponentTe * a function that initializes a builder to create the * {@link DeleteComponentTemplateRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-component-template.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-component-template.html">Documentation * on elastic.co</a> */ @@ -159,7 +159,7 @@ public final DeleteComponentTemplateResponse deleteComponentTemplate( * Clears cluster voting config exclusions. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/voting-config-exclusions.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/voting-config-exclusions.html">Documentation * on elastic.co</a> */ @@ -178,7 +178,7 @@ public BooleanResponse deleteVotingConfigExclusions(DeleteVotingConfigExclusions * a function that initializes a builder to create the * {@link DeleteVotingConfigExclusionsRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/voting-config-exclusions.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/voting-config-exclusions.html">Documentation * on elastic.co</a> */ @@ -192,7 +192,7 @@ public final BooleanResponse deleteVotingConfigExclusions( * Clears cluster voting config exclusions. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/voting-config-exclusions.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/voting-config-exclusions.html">Documentation * on elastic.co</a> */ @@ -208,7 +208,7 @@ public BooleanResponse deleteVotingConfigExclusions() throws IOException, Elasti * component template exists. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-component-template.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-component-template.html">Documentation * on elastic.co</a> */ @@ -228,7 +228,7 @@ public BooleanResponse existsComponentTemplate(ExistsComponentTemplateRequest re * a function that initializes a builder to create the * {@link ExistsComponentTemplateRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-component-template.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-component-template.html">Documentation * on elastic.co</a> */ @@ -244,7 +244,7 @@ public final BooleanResponse existsComponentTemplate( * Get component templates. Retrieves information about component templates. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-component-template.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-component-template.html">Documentation * on elastic.co</a> */ @@ -263,7 +263,7 @@ public GetComponentTemplateResponse getComponentTemplate(GetComponentTemplateReq * a function that initializes a builder to create the * {@link GetComponentTemplateRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-component-template.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-component-template.html">Documentation * on elastic.co</a> */ @@ -277,7 +277,7 @@ public final GetComponentTemplateResponse getComponentTemplate( * Get component templates. Retrieves information about component templates. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-component-template.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-component-template.html">Documentation * on elastic.co</a> */ @@ -293,7 +293,7 @@ public GetComponentTemplateResponse getComponentTemplate() throws IOException, E * been explicitly defined. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-get-settings.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-get-settings.html">Documentation * on elastic.co</a> */ @@ -313,7 +313,7 @@ public GetClusterSettingsResponse getSettings(GetClusterSettingsRequest request) * a function that initializes a builder to create the * {@link GetClusterSettingsRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-get-settings.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-get-settings.html">Documentation * on elastic.co</a> */ @@ -328,7 +328,7 @@ public final GetClusterSettingsResponse getSettings( * been explicitly defined. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-get-settings.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-get-settings.html">Documentation * on elastic.co</a> */ @@ -351,7 +351,7 @@ public GetClusterSettingsResponse getSettings() throws IOException, Elasticsearc * The cluster status is controlled by the worst index status. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-health.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-health.html">Documentation * on elastic.co</a> */ @@ -377,7 +377,7 @@ public HealthResponse health(HealthRequest request) throws IOException, Elastics * a function that initializes a builder to create the * {@link HealthRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-health.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-health.html">Documentation * on elastic.co</a> */ @@ -398,7 +398,7 @@ public final HealthResponse health(Function<HealthRequest.Builder, ObjectBuilder * The cluster status is controlled by the worst index status. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-health.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-health.html">Documentation * on elastic.co</a> */ @@ -413,7 +413,7 @@ public HealthResponse health() throws IOException, ElasticsearchException { * Get cluster info. Returns basic information about the cluster. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-info.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-info.html">Documentation * on elastic.co</a> */ @@ -431,7 +431,7 @@ public ClusterInfoResponse info(ClusterInfoRequest request) throws IOException, * a function that initializes a builder to create the * {@link ClusterInfoRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-info.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-info.html">Documentation * on elastic.co</a> */ @@ -453,7 +453,7 @@ public final ClusterInfoResponse info(Function<ClusterInfoRequest.Builder, Objec * reported by both task api and pending cluster tasks API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-pending.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-pending.html">Documentation * on elastic.co</a> */ @@ -478,7 +478,7 @@ public PendingTasksResponse pendingTasks(PendingTasksRequest request) throws IOE * a function that initializes a builder to create the * {@link PendingTasksRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-pending.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-pending.html">Documentation * on elastic.co</a> */ @@ -499,7 +499,7 @@ public final PendingTasksResponse pendingTasks( * reported by both task api and pending cluster tasks API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-pending.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-pending.html">Documentation * on elastic.co</a> */ @@ -514,7 +514,7 @@ public PendingTasksResponse pendingTasks() throws IOException, ElasticsearchExce * Updates the cluster voting config exclusions by node ids or node names. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/voting-config-exclusions.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/voting-config-exclusions.html">Documentation * on elastic.co</a> */ @@ -533,7 +533,7 @@ public BooleanResponse postVotingConfigExclusions(PostVotingConfigExclusionsRequ * a function that initializes a builder to create the * {@link PostVotingConfigExclusionsRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/voting-config-exclusions.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/voting-config-exclusions.html">Documentation * on elastic.co</a> */ @@ -547,7 +547,7 @@ public final BooleanResponse postVotingConfigExclusions( * Updates the cluster voting config exclusions by node ids or node names. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/voting-config-exclusions.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/voting-config-exclusions.html">Documentation * on elastic.co</a> */ @@ -582,7 +582,7 @@ public BooleanResponse postVotingConfigExclusions() throws IOException, Elastics * before the opening curly bracket. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-component-template.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-component-template.html">Documentation * on elastic.co</a> */ @@ -621,7 +621,7 @@ public PutComponentTemplateResponse putComponentTemplate(PutComponentTemplateReq * a function that initializes a builder to create the * {@link PutComponentTemplateRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-component-template.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-component-template.html">Documentation * on elastic.co</a> */ @@ -637,7 +637,7 @@ public final PutComponentTemplateResponse putComponentTemplate( * Updates the cluster settings. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-update-settings.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-update-settings.html">Documentation * on elastic.co</a> */ @@ -656,7 +656,7 @@ public PutClusterSettingsResponse putSettings(PutClusterSettingsRequest request) * a function that initializes a builder to create the * {@link PutClusterSettingsRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-update-settings.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-update-settings.html">Documentation * on elastic.co</a> */ @@ -670,7 +670,7 @@ public final PutClusterSettingsResponse putSettings( * Updates the cluster settings. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-update-settings.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-update-settings.html">Documentation * on elastic.co</a> */ @@ -687,7 +687,7 @@ public PutClusterSettingsResponse putSettings() throws IOException, Elasticsearc * keyed by the configured remote cluster alias. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-remote-info.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-remote-info.html">Documentation * on elastic.co</a> */ public RemoteInfoResponse remoteInfo() throws IOException, ElasticsearchException { @@ -701,7 +701,7 @@ public RemoteInfoResponse remoteInfo() throws IOException, ElasticsearchExceptio * Allows to manually change the allocation of individual shards in the cluster. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-reroute.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-reroute.html">Documentation * on elastic.co</a> */ @@ -719,7 +719,7 @@ public RerouteResponse reroute(RerouteRequest request) throws IOException, Elast * a function that initializes a builder to create the * {@link RerouteRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-reroute.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-reroute.html">Documentation * on elastic.co</a> */ @@ -732,7 +732,7 @@ public final RerouteResponse reroute(Function<RerouteRequest.Builder, ObjectBuil * Allows to manually change the allocation of individual shards in the cluster. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-reroute.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-reroute.html">Documentation * on elastic.co</a> */ @@ -747,7 +747,7 @@ public RerouteResponse reroute() throws IOException, ElasticsearchException { * Returns a comprehensive information about the state of the cluster. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-state.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-state.html">Documentation * on elastic.co</a> */ @@ -765,7 +765,7 @@ public StateResponse state(StateRequest request) throws IOException, Elasticsear * a function that initializes a builder to create the * {@link StateRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-state.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-state.html">Documentation * on elastic.co</a> */ @@ -778,7 +778,7 @@ public final StateResponse state(Function<StateRequest.Builder, ObjectBuilder<St * Returns a comprehensive information about the state of the cluster. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-state.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-state.html">Documentation * on elastic.co</a> */ @@ -796,7 +796,7 @@ public StateResponse state() throws IOException, ElasticsearchException { * plugins). * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-stats.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-stats.html">Documentation * on elastic.co</a> */ @@ -817,7 +817,7 @@ public ClusterStatsResponse stats(ClusterStatsRequest request) throws IOExceptio * a function that initializes a builder to create the * {@link ClusterStatsRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-stats.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-stats.html">Documentation * on elastic.co</a> */ @@ -834,7 +834,7 @@ public final ClusterStatsResponse stats( * plugins). * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-stats.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-stats.html">Documentation * on elastic.co</a> */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/reroute/CommandAllocateReplicaAction.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/reroute/CommandAllocateReplicaAction.java index f52d8aeed..103e89064 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/reroute/CommandAllocateReplicaAction.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/reroute/CommandAllocateReplicaAction.java @@ -56,7 +56,7 @@ /** * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/modules-cluster.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/modules-cluster.html">Documentation * on elastic.co</a> * @see <a href= * "../../doc-files/api-spec.html#cluster.reroute.CommandAllocateReplicaAction">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/CheckInRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/CheckInRequest.java index fc5fa4085..37129a044 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/CheckInRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/CheckInRequest.java @@ -56,8 +56,10 @@ // typedef: connector.check_in.Request /** - * Updates the last_seen field in the connector, and sets it to current - * timestamp + * Check in a connector. + * <p> + * Update the <code>last_seen</code> field in the connector and set it to the + * current timestamp. * * @see <a href="../doc-files/api-spec.html#connector.check_in.Request">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/DeleteConnectorRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/DeleteConnectorRequest.java index 9cb231331..87f611963 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/DeleteConnectorRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/DeleteConnectorRequest.java @@ -56,7 +56,12 @@ // typedef: connector.delete.Request /** - * Deletes a connector. + * Delete a connector. + * <p> + * Removes a connector and associated sync jobs. This is a destructive action + * that is not recoverable. NOTE: This action doesn’t delete any API keys, + * ingest pipelines, or data indices associated with the connector. These need + * to be removed manually. * * @see <a href="../doc-files/api-spec.html#connector.delete.Request">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/ElasticsearchConnectorAsyncClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/ElasticsearchConnectorAsyncClient.java index 926aad3b3..290030bf1 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/ElasticsearchConnectorAsyncClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/ElasticsearchConnectorAsyncClient.java @@ -70,11 +70,13 @@ public ElasticsearchConnectorAsyncClient withTransportOptions(@Nullable Transpor // ----- Endpoint: connector.check_in /** - * Updates the last_seen field in the connector, and sets it to current - * timestamp + * Check in a connector. + * <p> + * Update the <code>last_seen</code> field in the connector and set it to the + * current timestamp. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/check-in-connector-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/check-in-connector-api.html">Documentation * on elastic.co</a> */ @@ -86,14 +88,16 @@ public CompletableFuture<CheckInResponse> checkIn(CheckInRequest request) { } /** - * Updates the last_seen field in the connector, and sets it to current - * timestamp + * Check in a connector. + * <p> + * Update the <code>last_seen</code> field in the connector and set it to the + * current timestamp. * * @param fn * a function that initializes a builder to create the * {@link CheckInRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/check-in-connector-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/check-in-connector-api.html">Documentation * on elastic.co</a> */ @@ -105,10 +109,15 @@ public final CompletableFuture<CheckInResponse> checkIn( // ----- Endpoint: connector.delete /** - * Deletes a connector. + * Delete a connector. + * <p> + * Removes a connector and associated sync jobs. This is a destructive action + * that is not recoverable. NOTE: This action doesn’t delete any API keys, + * ingest pipelines, or data indices associated with the connector. These need + * to be removed manually. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-connector-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-connector-api.html">Documentation * on elastic.co</a> */ @@ -120,13 +129,18 @@ public CompletableFuture<DeleteConnectorResponse> delete(DeleteConnectorRequest } /** - * Deletes a connector. + * Delete a connector. + * <p> + * Removes a connector and associated sync jobs. This is a destructive action + * that is not recoverable. NOTE: This action doesn’t delete any API keys, + * ingest pipelines, or data indices associated with the connector. These need + * to be removed manually. * * @param fn * a function that initializes a builder to create the * {@link DeleteConnectorRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-connector-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-connector-api.html">Documentation * on elastic.co</a> */ @@ -138,10 +152,12 @@ public final CompletableFuture<DeleteConnectorResponse> delete( // ----- Endpoint: connector.get /** - * Retrieves a connector. + * Get a connector. + * <p> + * Get the details about a connector. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-connector-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-connector-api.html">Documentation * on elastic.co</a> */ @@ -153,13 +169,15 @@ public CompletableFuture<GetConnectorResponse> get(GetConnectorRequest request) } /** - * Retrieves a connector. + * Get a connector. + * <p> + * Get the details about a connector. * * @param fn * a function that initializes a builder to create the * {@link GetConnectorRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-connector-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-connector-api.html">Documentation * on elastic.co</a> */ @@ -171,10 +189,12 @@ public final CompletableFuture<GetConnectorResponse> get( // ----- Endpoint: connector.list /** - * Returns existing connectors. + * Get all connectors. + * <p> + * Get information about all connectors. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/list-connector-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/list-connector-api.html">Documentation * on elastic.co</a> */ @@ -186,13 +206,15 @@ public CompletableFuture<ListResponse> list(ListRequest request) { } /** - * Returns existing connectors. + * Get all connectors. + * <p> + * Get information about all connectors. * * @param fn * a function that initializes a builder to create the * {@link ListRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/list-connector-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/list-connector-api.html">Documentation * on elastic.co</a> */ @@ -201,10 +223,12 @@ public final CompletableFuture<ListResponse> list(Function<ListRequest.Builder, } /** - * Returns existing connectors. + * Get all connectors. + * <p> + * Get information about all connectors. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/list-connector-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/list-connector-api.html">Documentation * on elastic.co</a> */ @@ -216,10 +240,16 @@ public CompletableFuture<ListResponse> list() { // ----- Endpoint: connector.post /** - * Creates a connector. + * Create a connector. + * <p> + * Connectors are Elasticsearch integrations that bring content from third-party + * data sources, which can be deployed on Elastic Cloud or hosted on your own + * infrastructure. Elastic managed connectors (Native connectors) are a managed + * service on Elastic Cloud. Self-managed connectors (Connector clients) are + * self-managed on your infrastructure. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/create-connector-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/create-connector-api.html">Documentation * on elastic.co</a> */ @@ -231,13 +261,19 @@ public CompletableFuture<PostResponse> post(PostRequest request) { } /** - * Creates a connector. + * Create a connector. + * <p> + * Connectors are Elasticsearch integrations that bring content from third-party + * data sources, which can be deployed on Elastic Cloud or hosted on your own + * infrastructure. Elastic managed connectors (Native connectors) are a managed + * service on Elastic Cloud. Self-managed connectors (Connector clients) are + * self-managed on your infrastructure. * * @param fn * a function that initializes a builder to create the * {@link PostRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/create-connector-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/create-connector-api.html">Documentation * on elastic.co</a> */ @@ -246,10 +282,16 @@ public final CompletableFuture<PostResponse> post(Function<PostRequest.Builder, } /** - * Creates a connector. + * Create a connector. + * <p> + * Connectors are Elasticsearch integrations that bring content from third-party + * data sources, which can be deployed on Elastic Cloud or hosted on your own + * infrastructure. Elastic managed connectors (Native connectors) are a managed + * service on Elastic Cloud. Self-managed connectors (Connector clients) are + * self-managed on your infrastructure. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/create-connector-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/create-connector-api.html">Documentation * on elastic.co</a> */ @@ -261,10 +303,10 @@ public CompletableFuture<PostResponse> post() { // ----- Endpoint: connector.put /** - * Creates or updates a connector. + * Create or update a connector. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/create-connector-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/create-connector-api.html">Documentation * on elastic.co</a> */ @@ -276,13 +318,13 @@ public CompletableFuture<PutResponse> put(PutRequest request) { } /** - * Creates or updates a connector. + * Create or update a connector. * * @param fn * a function that initializes a builder to create the * {@link PutRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/create-connector-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/create-connector-api.html">Documentation * on elastic.co</a> */ @@ -291,10 +333,10 @@ public final CompletableFuture<PutResponse> put(Function<PutRequest.Builder, Obj } /** - * Creates or updates a connector. + * Create or update a connector. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/create-connector-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/create-connector-api.html">Documentation * on elastic.co</a> */ @@ -306,10 +348,15 @@ public CompletableFuture<PutResponse> put() { // ----- Endpoint: connector.sync_job_cancel /** - * Cancels a connector sync job. + * Cancel a connector sync job. + * <p> + * Cancel a connector sync job, which sets the status to cancelling and updates + * <code>cancellation_requested_at</code> to the current time. The connector + * service is then responsible for setting the status of connector sync jobs to + * cancelled. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cancel-connector-sync-job-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cancel-connector-sync-job-api.html">Documentation * on elastic.co</a> */ @@ -321,13 +368,18 @@ public CompletableFuture<SyncJobCancelResponse> syncJobCancel(SyncJobCancelReque } /** - * Cancels a connector sync job. + * Cancel a connector sync job. + * <p> + * Cancel a connector sync job, which sets the status to cancelling and updates + * <code>cancellation_requested_at</code> to the current time. The connector + * service is then responsible for setting the status of connector sync jobs to + * cancelled. * * @param fn * a function that initializes a builder to create the * {@link SyncJobCancelRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cancel-connector-sync-job-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cancel-connector-sync-job-api.html">Documentation * on elastic.co</a> */ @@ -339,10 +391,13 @@ public final CompletableFuture<SyncJobCancelResponse> syncJobCancel( // ----- Endpoint: connector.sync_job_delete /** - * Deletes a connector sync job. + * Delete a connector sync job. + * <p> + * Remove a connector sync job and its associated data. This is a destructive + * action that is not recoverable. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-connector-sync-job-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-connector-sync-job-api.html">Documentation * on elastic.co</a> */ @@ -354,13 +409,16 @@ public CompletableFuture<SyncJobDeleteResponse> syncJobDelete(SyncJobDeleteReque } /** - * Deletes a connector sync job. + * Delete a connector sync job. + * <p> + * Remove a connector sync job and its associated data. This is a destructive + * action that is not recoverable. * * @param fn * a function that initializes a builder to create the * {@link SyncJobDeleteRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-connector-sync-job-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-connector-sync-job-api.html">Documentation * on elastic.co</a> */ @@ -372,10 +430,10 @@ public final CompletableFuture<SyncJobDeleteResponse> syncJobDelete( // ----- Endpoint: connector.sync_job_get /** - * Retrieves a connector sync job. + * Get a connector sync job. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-connector-sync-job-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-connector-sync-job-api.html">Documentation * on elastic.co</a> */ @@ -387,13 +445,13 @@ public CompletableFuture<SyncJobGetResponse> syncJobGet(SyncJobGetRequest reques } /** - * Retrieves a connector sync job. + * Get a connector sync job. * * @param fn * a function that initializes a builder to create the * {@link SyncJobGetRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-connector-sync-job-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-connector-sync-job-api.html">Documentation * on elastic.co</a> */ @@ -405,10 +463,13 @@ public final CompletableFuture<SyncJobGetResponse> syncJobGet( // ----- Endpoint: connector.sync_job_list /** - * Lists connector sync jobs. + * Get all connector sync jobs. + * <p> + * Get information about all stored connector sync jobs listed by their creation + * date in ascending order. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/list-connector-sync-jobs-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/list-connector-sync-jobs-api.html">Documentation * on elastic.co</a> */ @@ -420,13 +481,16 @@ public CompletableFuture<SyncJobListResponse> syncJobList(SyncJobListRequest req } /** - * Lists connector sync jobs. + * Get all connector sync jobs. + * <p> + * Get information about all stored connector sync jobs listed by their creation + * date in ascending order. * * @param fn * a function that initializes a builder to create the * {@link SyncJobListRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/list-connector-sync-jobs-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/list-connector-sync-jobs-api.html">Documentation * on elastic.co</a> */ @@ -436,10 +500,13 @@ public final CompletableFuture<SyncJobListResponse> syncJobList( } /** - * Lists connector sync jobs. + * Get all connector sync jobs. + * <p> + * Get information about all stored connector sync jobs listed by their creation + * date in ascending order. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/list-connector-sync-jobs-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/list-connector-sync-jobs-api.html">Documentation * on elastic.co</a> */ @@ -451,10 +518,13 @@ public CompletableFuture<SyncJobListResponse> syncJobList() { // ----- Endpoint: connector.sync_job_post /** - * Creates a connector sync job. + * Create a connector sync job. + * <p> + * Create a connector sync job document in the internal index and initialize its + * counters and timestamps with default values. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/create-connector-sync-job-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/create-connector-sync-job-api.html">Documentation * on elastic.co</a> */ @@ -466,13 +536,16 @@ public CompletableFuture<SyncJobPostResponse> syncJobPost(SyncJobPostRequest req } /** - * Creates a connector sync job. + * Create a connector sync job. + * <p> + * Create a connector sync job document in the internal index and initialize its + * counters and timestamps with default values. * * @param fn * a function that initializes a builder to create the * {@link SyncJobPostRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/create-connector-sync-job-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/create-connector-sync-job-api.html">Documentation * on elastic.co</a> */ @@ -484,10 +557,12 @@ public final CompletableFuture<SyncJobPostResponse> syncJobPost( // ----- Endpoint: connector.update_active_filtering /** + * Activate the connector draft filter. + * <p> * Activates the valid draft filtering for a connector. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-filtering-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-filtering-api.html">Documentation * on elastic.co</a> */ @@ -500,13 +575,15 @@ public CompletableFuture<UpdateActiveFilteringResponse> updateActiveFiltering( } /** + * Activate the connector draft filter. + * <p> * Activates the valid draft filtering for a connector. * * @param fn * a function that initializes a builder to create the * {@link UpdateActiveFilteringRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-filtering-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-filtering-api.html">Documentation * on elastic.co</a> */ @@ -518,10 +595,16 @@ public final CompletableFuture<UpdateActiveFilteringResponse> updateActiveFilter // ----- Endpoint: connector.update_api_key_id /** - * Updates the API key id in the connector document + * Update the connector API key ID. + * <p> + * Update the <code>api_key_id</code> and <code>api_key_secret_id</code> fields + * of a connector. You can specify the ID of the API key used for authorization + * and the ID of the connector secret where the API key is stored. The connector + * secret ID is required only for Elastic managed (native) connectors. + * Self-managed connectors (connector clients) do not use this field. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-api-key-id-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-api-key-id-api.html">Documentation * on elastic.co</a> */ @@ -533,13 +616,19 @@ public CompletableFuture<UpdateApiKeyIdResponse> updateApiKeyId(UpdateApiKeyIdRe } /** - * Updates the API key id in the connector document + * Update the connector API key ID. + * <p> + * Update the <code>api_key_id</code> and <code>api_key_secret_id</code> fields + * of a connector. You can specify the ID of the API key used for authorization + * and the ID of the connector secret where the API key is stored. The connector + * secret ID is required only for Elastic managed (native) connectors. + * Self-managed connectors (connector clients) do not use this field. * * @param fn * a function that initializes a builder to create the * {@link UpdateApiKeyIdRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-api-key-id-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-api-key-id-api.html">Documentation * on elastic.co</a> */ @@ -551,10 +640,12 @@ public final CompletableFuture<UpdateApiKeyIdResponse> updateApiKeyId( // ----- Endpoint: connector.update_configuration /** - * Updates the configuration field in the connector document + * Update the connector configuration. + * <p> + * Update the configuration field in the connector document. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-configuration-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-configuration-api.html">Documentation * on elastic.co</a> */ @@ -566,13 +657,15 @@ public CompletableFuture<UpdateConfigurationResponse> updateConfiguration(Update } /** - * Updates the configuration field in the connector document + * Update the connector configuration. + * <p> + * Update the configuration field in the connector document. * * @param fn * a function that initializes a builder to create the * {@link UpdateConfigurationRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-configuration-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-configuration-api.html">Documentation * on elastic.co</a> */ @@ -584,10 +677,14 @@ public final CompletableFuture<UpdateConfigurationResponse> updateConfiguration( // ----- Endpoint: connector.update_error /** - * Updates the filtering field in the connector document + * Update the connector error field. + * <p> + * Set the error field for the connector. If the error provided in the request + * body is non-null, the connector’s status is updated to error. Otherwise, if + * the error is reset to null, the connector status is updated to connected. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-error-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-error-api.html">Documentation * on elastic.co</a> */ @@ -599,13 +696,17 @@ public CompletableFuture<UpdateErrorResponse> updateError(UpdateErrorRequest req } /** - * Updates the filtering field in the connector document + * Update the connector error field. + * <p> + * Set the error field for the connector. If the error provided in the request + * body is non-null, the connector’s status is updated to error. Otherwise, if + * the error is reset to null, the connector status is updated to connected. * * @param fn * a function that initializes a builder to create the * {@link UpdateErrorRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-error-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-error-api.html">Documentation * on elastic.co</a> */ @@ -617,10 +718,15 @@ public final CompletableFuture<UpdateErrorResponse> updateError( // ----- Endpoint: connector.update_filtering /** - * Updates the filtering field in the connector document + * Update the connector filtering. + * <p> + * Update the draft filtering configuration of a connector and marks the draft + * validation state as edited. The filtering draft is activated once validated + * by the running Elastic connector service. The filtering property is used to + * configure sync rules (both basic and advanced) for a connector. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-filtering-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-filtering-api.html">Documentation * on elastic.co</a> */ @@ -632,13 +738,18 @@ public CompletableFuture<UpdateFilteringResponse> updateFiltering(UpdateFilterin } /** - * Updates the filtering field in the connector document + * Update the connector filtering. + * <p> + * Update the draft filtering configuration of a connector and marks the draft + * validation state as edited. The filtering draft is activated once validated + * by the running Elastic connector service. The filtering property is used to + * configure sync rules (both basic and advanced) for a connector. * * @param fn * a function that initializes a builder to create the * {@link UpdateFilteringRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-filtering-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-filtering-api.html">Documentation * on elastic.co</a> */ @@ -650,10 +761,12 @@ public final CompletableFuture<UpdateFilteringResponse> updateFiltering( // ----- Endpoint: connector.update_filtering_validation /** - * Updates the draft filtering validation info for a connector. + * Update the connector draft filtering validation. + * <p> + * Update the draft filtering validation info for a connector. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-filtering-validation-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-filtering-validation-api.html">Documentation * on elastic.co</a> */ @@ -666,13 +779,15 @@ public CompletableFuture<UpdateFilteringValidationResponse> updateFilteringValid } /** - * Updates the draft filtering validation info for a connector. + * Update the connector draft filtering validation. + * <p> + * Update the draft filtering validation info for a connector. * * @param fn * a function that initializes a builder to create the * {@link UpdateFilteringValidationRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-filtering-validation-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-filtering-validation-api.html">Documentation * on elastic.co</a> */ @@ -684,10 +799,13 @@ public final CompletableFuture<UpdateFilteringValidationResponse> updateFilterin // ----- Endpoint: connector.update_index_name /** - * Updates the index_name in the connector document + * Update the connector index name. + * <p> + * Update the <code>index_name</code> field of a connector, specifying the index + * where the data ingested by the connector is stored. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-index-name-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-index-name-api.html">Documentation * on elastic.co</a> */ @@ -699,13 +817,16 @@ public CompletableFuture<UpdateIndexNameResponse> updateIndexName(UpdateIndexNam } /** - * Updates the index_name in the connector document + * Update the connector index name. + * <p> + * Update the <code>index_name</code> field of a connector, specifying the index + * where the data ingested by the connector is stored. * * @param fn * a function that initializes a builder to create the * {@link UpdateIndexNameRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-index-name-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-index-name-api.html">Documentation * on elastic.co</a> */ @@ -717,10 +838,10 @@ public final CompletableFuture<UpdateIndexNameResponse> updateIndexName( // ----- Endpoint: connector.update_name /** - * Updates the name and description fields in the connector document + * Update the connector name and description. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-name-description-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-name-description-api.html">Documentation * on elastic.co</a> */ @@ -732,13 +853,13 @@ public CompletableFuture<UpdateNameResponse> updateName(UpdateNameRequest reques } /** - * Updates the name and description fields in the connector document + * Update the connector name and description. * * @param fn * a function that initializes a builder to create the * {@link UpdateNameRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-name-description-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-name-description-api.html">Documentation * on elastic.co</a> */ @@ -750,10 +871,10 @@ public final CompletableFuture<UpdateNameResponse> updateName( // ----- Endpoint: connector.update_native /** - * Updates the is_native flag in the connector document + * Update the connector is_native flag. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-native-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-native-api.html">Documentation * on elastic.co</a> */ @@ -765,13 +886,13 @@ public CompletableFuture<UpdateNativeResponse> updateNative(UpdateNativeRequest } /** - * Updates the is_native flag in the connector document + * Update the connector is_native flag. * * @param fn * a function that initializes a builder to create the * {@link UpdateNativeRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-native-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-native-api.html">Documentation * on elastic.co</a> */ @@ -783,10 +904,13 @@ public final CompletableFuture<UpdateNativeResponse> updateNative( // ----- Endpoint: connector.update_pipeline /** - * Updates the pipeline field in the connector document + * Update the connector pipeline. + * <p> + * When you create a new connector, the configuration of an ingest pipeline is + * populated with default settings. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-pipeline-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-pipeline-api.html">Documentation * on elastic.co</a> */ @@ -798,13 +922,16 @@ public CompletableFuture<UpdatePipelineResponse> updatePipeline(UpdatePipelineRe } /** - * Updates the pipeline field in the connector document + * Update the connector pipeline. + * <p> + * When you create a new connector, the configuration of an ingest pipeline is + * populated with default settings. * * @param fn * a function that initializes a builder to create the * {@link UpdatePipelineRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-pipeline-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-pipeline-api.html">Documentation * on elastic.co</a> */ @@ -816,10 +943,10 @@ public final CompletableFuture<UpdatePipelineResponse> updatePipeline( // ----- Endpoint: connector.update_scheduling /** - * Updates the scheduling field in the connector document + * Update the connector scheduling. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-scheduling-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-scheduling-api.html">Documentation * on elastic.co</a> */ @@ -831,13 +958,13 @@ public CompletableFuture<UpdateSchedulingResponse> updateScheduling(UpdateSchedu } /** - * Updates the scheduling field in the connector document + * Update the connector scheduling. * * @param fn * a function that initializes a builder to create the * {@link UpdateSchedulingRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-scheduling-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-scheduling-api.html">Documentation * on elastic.co</a> */ @@ -849,10 +976,10 @@ public final CompletableFuture<UpdateSchedulingResponse> updateScheduling( // ----- Endpoint: connector.update_service_type /** - * Updates the service type of the connector + * Update the connector service type. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-service-type-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-service-type-api.html">Documentation * on elastic.co</a> */ @@ -864,13 +991,13 @@ public CompletableFuture<UpdateServiceTypeResponse> updateServiceType(UpdateServ } /** - * Updates the service type of the connector + * Update the connector service type. * * @param fn * a function that initializes a builder to create the * {@link UpdateServiceTypeRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-service-type-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-service-type-api.html">Documentation * on elastic.co</a> */ @@ -882,10 +1009,10 @@ public final CompletableFuture<UpdateServiceTypeResponse> updateServiceType( // ----- Endpoint: connector.update_status /** - * Updates the status of the connector + * Update the connector status. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-status-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-status-api.html">Documentation * on elastic.co</a> */ @@ -897,13 +1024,13 @@ public CompletableFuture<UpdateStatusResponse> updateStatus(UpdateStatusRequest } /** - * Updates the status of the connector + * Update the connector status. * * @param fn * a function that initializes a builder to create the * {@link UpdateStatusRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-status-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-status-api.html">Documentation * on elastic.co</a> */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/ElasticsearchConnectorClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/ElasticsearchConnectorClient.java index 7a1f4bf6b..252ff7abd 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/ElasticsearchConnectorClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/ElasticsearchConnectorClient.java @@ -68,11 +68,13 @@ public ElasticsearchConnectorClient withTransportOptions(@Nullable TransportOpti // ----- Endpoint: connector.check_in /** - * Updates the last_seen field in the connector, and sets it to current - * timestamp + * Check in a connector. + * <p> + * Update the <code>last_seen</code> field in the connector and set it to the + * current timestamp. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/check-in-connector-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/check-in-connector-api.html">Documentation * on elastic.co</a> */ @@ -84,14 +86,16 @@ public CheckInResponse checkIn(CheckInRequest request) throws IOException, Elast } /** - * Updates the last_seen field in the connector, and sets it to current - * timestamp + * Check in a connector. + * <p> + * Update the <code>last_seen</code> field in the connector and set it to the + * current timestamp. * * @param fn * a function that initializes a builder to create the * {@link CheckInRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/check-in-connector-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/check-in-connector-api.html">Documentation * on elastic.co</a> */ @@ -103,10 +107,15 @@ public final CheckInResponse checkIn(Function<CheckInRequest.Builder, ObjectBuil // ----- Endpoint: connector.delete /** - * Deletes a connector. + * Delete a connector. + * <p> + * Removes a connector and associated sync jobs. This is a destructive action + * that is not recoverable. NOTE: This action doesn’t delete any API keys, + * ingest pipelines, or data indices associated with the connector. These need + * to be removed manually. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-connector-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-connector-api.html">Documentation * on elastic.co</a> */ @@ -118,13 +127,18 @@ public DeleteConnectorResponse delete(DeleteConnectorRequest request) throws IOE } /** - * Deletes a connector. + * Delete a connector. + * <p> + * Removes a connector and associated sync jobs. This is a destructive action + * that is not recoverable. NOTE: This action doesn’t delete any API keys, + * ingest pipelines, or data indices associated with the connector. These need + * to be removed manually. * * @param fn * a function that initializes a builder to create the * {@link DeleteConnectorRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-connector-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-connector-api.html">Documentation * on elastic.co</a> */ @@ -137,10 +151,12 @@ public final DeleteConnectorResponse delete( // ----- Endpoint: connector.get /** - * Retrieves a connector. + * Get a connector. + * <p> + * Get the details about a connector. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-connector-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-connector-api.html">Documentation * on elastic.co</a> */ @@ -152,13 +168,15 @@ public GetConnectorResponse get(GetConnectorRequest request) throws IOException, } /** - * Retrieves a connector. + * Get a connector. + * <p> + * Get the details about a connector. * * @param fn * a function that initializes a builder to create the * {@link GetConnectorRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-connector-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-connector-api.html">Documentation * on elastic.co</a> */ @@ -170,10 +188,12 @@ public final GetConnectorResponse get(Function<GetConnectorRequest.Builder, Obje // ----- Endpoint: connector.list /** - * Returns existing connectors. + * Get all connectors. + * <p> + * Get information about all connectors. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/list-connector-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/list-connector-api.html">Documentation * on elastic.co</a> */ @@ -185,13 +205,15 @@ public ListResponse list(ListRequest request) throws IOException, ElasticsearchE } /** - * Returns existing connectors. + * Get all connectors. + * <p> + * Get information about all connectors. * * @param fn * a function that initializes a builder to create the * {@link ListRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/list-connector-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/list-connector-api.html">Documentation * on elastic.co</a> */ @@ -201,10 +223,12 @@ public final ListResponse list(Function<ListRequest.Builder, ObjectBuilder<ListR } /** - * Returns existing connectors. + * Get all connectors. + * <p> + * Get information about all connectors. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/list-connector-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/list-connector-api.html">Documentation * on elastic.co</a> */ @@ -216,10 +240,16 @@ public ListResponse list() throws IOException, ElasticsearchException { // ----- Endpoint: connector.post /** - * Creates a connector. + * Create a connector. + * <p> + * Connectors are Elasticsearch integrations that bring content from third-party + * data sources, which can be deployed on Elastic Cloud or hosted on your own + * infrastructure. Elastic managed connectors (Native connectors) are a managed + * service on Elastic Cloud. Self-managed connectors (Connector clients) are + * self-managed on your infrastructure. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/create-connector-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/create-connector-api.html">Documentation * on elastic.co</a> */ @@ -231,13 +261,19 @@ public PostResponse post(PostRequest request) throws IOException, ElasticsearchE } /** - * Creates a connector. + * Create a connector. + * <p> + * Connectors are Elasticsearch integrations that bring content from third-party + * data sources, which can be deployed on Elastic Cloud or hosted on your own + * infrastructure. Elastic managed connectors (Native connectors) are a managed + * service on Elastic Cloud. Self-managed connectors (Connector clients) are + * self-managed on your infrastructure. * * @param fn * a function that initializes a builder to create the * {@link PostRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/create-connector-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/create-connector-api.html">Documentation * on elastic.co</a> */ @@ -247,10 +283,16 @@ public final PostResponse post(Function<PostRequest.Builder, ObjectBuilder<PostR } /** - * Creates a connector. + * Create a connector. + * <p> + * Connectors are Elasticsearch integrations that bring content from third-party + * data sources, which can be deployed on Elastic Cloud or hosted on your own + * infrastructure. Elastic managed connectors (Native connectors) are a managed + * service on Elastic Cloud. Self-managed connectors (Connector clients) are + * self-managed on your infrastructure. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/create-connector-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/create-connector-api.html">Documentation * on elastic.co</a> */ @@ -262,10 +304,10 @@ public PostResponse post() throws IOException, ElasticsearchException { // ----- Endpoint: connector.put /** - * Creates or updates a connector. + * Create or update a connector. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/create-connector-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/create-connector-api.html">Documentation * on elastic.co</a> */ @@ -277,13 +319,13 @@ public PutResponse put(PutRequest request) throws IOException, ElasticsearchExce } /** - * Creates or updates a connector. + * Create or update a connector. * * @param fn * a function that initializes a builder to create the * {@link PutRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/create-connector-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/create-connector-api.html">Documentation * on elastic.co</a> */ @@ -293,10 +335,10 @@ public final PutResponse put(Function<PutRequest.Builder, ObjectBuilder<PutReque } /** - * Creates or updates a connector. + * Create or update a connector. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/create-connector-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/create-connector-api.html">Documentation * on elastic.co</a> */ @@ -308,10 +350,15 @@ public PutResponse put() throws IOException, ElasticsearchException { // ----- Endpoint: connector.sync_job_cancel /** - * Cancels a connector sync job. + * Cancel a connector sync job. + * <p> + * Cancel a connector sync job, which sets the status to cancelling and updates + * <code>cancellation_requested_at</code> to the current time. The connector + * service is then responsible for setting the status of connector sync jobs to + * cancelled. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cancel-connector-sync-job-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cancel-connector-sync-job-api.html">Documentation * on elastic.co</a> */ @@ -324,13 +371,18 @@ public SyncJobCancelResponse syncJobCancel(SyncJobCancelRequest request) } /** - * Cancels a connector sync job. + * Cancel a connector sync job. + * <p> + * Cancel a connector sync job, which sets the status to cancelling and updates + * <code>cancellation_requested_at</code> to the current time. The connector + * service is then responsible for setting the status of connector sync jobs to + * cancelled. * * @param fn * a function that initializes a builder to create the * {@link SyncJobCancelRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cancel-connector-sync-job-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cancel-connector-sync-job-api.html">Documentation * on elastic.co</a> */ @@ -343,10 +395,13 @@ public final SyncJobCancelResponse syncJobCancel( // ----- Endpoint: connector.sync_job_delete /** - * Deletes a connector sync job. + * Delete a connector sync job. + * <p> + * Remove a connector sync job and its associated data. This is a destructive + * action that is not recoverable. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-connector-sync-job-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-connector-sync-job-api.html">Documentation * on elastic.co</a> */ @@ -359,13 +414,16 @@ public SyncJobDeleteResponse syncJobDelete(SyncJobDeleteRequest request) } /** - * Deletes a connector sync job. + * Delete a connector sync job. + * <p> + * Remove a connector sync job and its associated data. This is a destructive + * action that is not recoverable. * * @param fn * a function that initializes a builder to create the * {@link SyncJobDeleteRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-connector-sync-job-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-connector-sync-job-api.html">Documentation * on elastic.co</a> */ @@ -378,10 +436,10 @@ public final SyncJobDeleteResponse syncJobDelete( // ----- Endpoint: connector.sync_job_get /** - * Retrieves a connector sync job. + * Get a connector sync job. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-connector-sync-job-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-connector-sync-job-api.html">Documentation * on elastic.co</a> */ @@ -393,13 +451,13 @@ public SyncJobGetResponse syncJobGet(SyncJobGetRequest request) throws IOExcepti } /** - * Retrieves a connector sync job. + * Get a connector sync job. * * @param fn * a function that initializes a builder to create the * {@link SyncJobGetRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-connector-sync-job-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-connector-sync-job-api.html">Documentation * on elastic.co</a> */ @@ -411,10 +469,13 @@ public final SyncJobGetResponse syncJobGet(Function<SyncJobGetRequest.Builder, O // ----- Endpoint: connector.sync_job_list /** - * Lists connector sync jobs. + * Get all connector sync jobs. + * <p> + * Get information about all stored connector sync jobs listed by their creation + * date in ascending order. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/list-connector-sync-jobs-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/list-connector-sync-jobs-api.html">Documentation * on elastic.co</a> */ @@ -426,13 +487,16 @@ public SyncJobListResponse syncJobList(SyncJobListRequest request) throws IOExce } /** - * Lists connector sync jobs. + * Get all connector sync jobs. + * <p> + * Get information about all stored connector sync jobs listed by their creation + * date in ascending order. * * @param fn * a function that initializes a builder to create the * {@link SyncJobListRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/list-connector-sync-jobs-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/list-connector-sync-jobs-api.html">Documentation * on elastic.co</a> */ @@ -443,10 +507,13 @@ public final SyncJobListResponse syncJobList( } /** - * Lists connector sync jobs. + * Get all connector sync jobs. + * <p> + * Get information about all stored connector sync jobs listed by their creation + * date in ascending order. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/list-connector-sync-jobs-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/list-connector-sync-jobs-api.html">Documentation * on elastic.co</a> */ @@ -458,10 +525,13 @@ public SyncJobListResponse syncJobList() throws IOException, ElasticsearchExcept // ----- Endpoint: connector.sync_job_post /** - * Creates a connector sync job. + * Create a connector sync job. + * <p> + * Create a connector sync job document in the internal index and initialize its + * counters and timestamps with default values. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/create-connector-sync-job-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/create-connector-sync-job-api.html">Documentation * on elastic.co</a> */ @@ -473,13 +543,16 @@ public SyncJobPostResponse syncJobPost(SyncJobPostRequest request) throws IOExce } /** - * Creates a connector sync job. + * Create a connector sync job. + * <p> + * Create a connector sync job document in the internal index and initialize its + * counters and timestamps with default values. * * @param fn * a function that initializes a builder to create the * {@link SyncJobPostRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/create-connector-sync-job-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/create-connector-sync-job-api.html">Documentation * on elastic.co</a> */ @@ -492,10 +565,12 @@ public final SyncJobPostResponse syncJobPost( // ----- Endpoint: connector.update_active_filtering /** + * Activate the connector draft filter. + * <p> * Activates the valid draft filtering for a connector. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-filtering-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-filtering-api.html">Documentation * on elastic.co</a> */ @@ -508,13 +583,15 @@ public UpdateActiveFilteringResponse updateActiveFiltering(UpdateActiveFiltering } /** + * Activate the connector draft filter. + * <p> * Activates the valid draft filtering for a connector. * * @param fn * a function that initializes a builder to create the * {@link UpdateActiveFilteringRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-filtering-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-filtering-api.html">Documentation * on elastic.co</a> */ @@ -527,10 +604,16 @@ public final UpdateActiveFilteringResponse updateActiveFiltering( // ----- Endpoint: connector.update_api_key_id /** - * Updates the API key id in the connector document + * Update the connector API key ID. + * <p> + * Update the <code>api_key_id</code> and <code>api_key_secret_id</code> fields + * of a connector. You can specify the ID of the API key used for authorization + * and the ID of the connector secret where the API key is stored. The connector + * secret ID is required only for Elastic managed (native) connectors. + * Self-managed connectors (connector clients) do not use this field. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-api-key-id-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-api-key-id-api.html">Documentation * on elastic.co</a> */ @@ -543,13 +626,19 @@ public UpdateApiKeyIdResponse updateApiKeyId(UpdateApiKeyIdRequest request) } /** - * Updates the API key id in the connector document + * Update the connector API key ID. + * <p> + * Update the <code>api_key_id</code> and <code>api_key_secret_id</code> fields + * of a connector. You can specify the ID of the API key used for authorization + * and the ID of the connector secret where the API key is stored. The connector + * secret ID is required only for Elastic managed (native) connectors. + * Self-managed connectors (connector clients) do not use this field. * * @param fn * a function that initializes a builder to create the * {@link UpdateApiKeyIdRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-api-key-id-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-api-key-id-api.html">Documentation * on elastic.co</a> */ @@ -562,10 +651,12 @@ public final UpdateApiKeyIdResponse updateApiKeyId( // ----- Endpoint: connector.update_configuration /** - * Updates the configuration field in the connector document + * Update the connector configuration. + * <p> + * Update the configuration field in the connector document. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-configuration-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-configuration-api.html">Documentation * on elastic.co</a> */ @@ -578,13 +669,15 @@ public UpdateConfigurationResponse updateConfiguration(UpdateConfigurationReques } /** - * Updates the configuration field in the connector document + * Update the connector configuration. + * <p> + * Update the configuration field in the connector document. * * @param fn * a function that initializes a builder to create the * {@link UpdateConfigurationRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-configuration-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-configuration-api.html">Documentation * on elastic.co</a> */ @@ -597,10 +690,14 @@ public final UpdateConfigurationResponse updateConfiguration( // ----- Endpoint: connector.update_error /** - * Updates the filtering field in the connector document + * Update the connector error field. + * <p> + * Set the error field for the connector. If the error provided in the request + * body is non-null, the connector’s status is updated to error. Otherwise, if + * the error is reset to null, the connector status is updated to connected. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-error-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-error-api.html">Documentation * on elastic.co</a> */ @@ -612,13 +709,17 @@ public UpdateErrorResponse updateError(UpdateErrorRequest request) throws IOExce } /** - * Updates the filtering field in the connector document + * Update the connector error field. + * <p> + * Set the error field for the connector. If the error provided in the request + * body is non-null, the connector’s status is updated to error. Otherwise, if + * the error is reset to null, the connector status is updated to connected. * * @param fn * a function that initializes a builder to create the * {@link UpdateErrorRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-error-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-error-api.html">Documentation * on elastic.co</a> */ @@ -631,10 +732,15 @@ public final UpdateErrorResponse updateError( // ----- Endpoint: connector.update_filtering /** - * Updates the filtering field in the connector document + * Update the connector filtering. + * <p> + * Update the draft filtering configuration of a connector and marks the draft + * validation state as edited. The filtering draft is activated once validated + * by the running Elastic connector service. The filtering property is used to + * configure sync rules (both basic and advanced) for a connector. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-filtering-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-filtering-api.html">Documentation * on elastic.co</a> */ @@ -647,13 +753,18 @@ public UpdateFilteringResponse updateFiltering(UpdateFilteringRequest request) } /** - * Updates the filtering field in the connector document + * Update the connector filtering. + * <p> + * Update the draft filtering configuration of a connector and marks the draft + * validation state as edited. The filtering draft is activated once validated + * by the running Elastic connector service. The filtering property is used to + * configure sync rules (both basic and advanced) for a connector. * * @param fn * a function that initializes a builder to create the * {@link UpdateFilteringRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-filtering-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-filtering-api.html">Documentation * on elastic.co</a> */ @@ -666,10 +777,12 @@ public final UpdateFilteringResponse updateFiltering( // ----- Endpoint: connector.update_filtering_validation /** - * Updates the draft filtering validation info for a connector. + * Update the connector draft filtering validation. + * <p> + * Update the draft filtering validation info for a connector. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-filtering-validation-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-filtering-validation-api.html">Documentation * on elastic.co</a> */ @@ -682,13 +795,15 @@ public UpdateFilteringValidationResponse updateFilteringValidation(UpdateFilteri } /** - * Updates the draft filtering validation info for a connector. + * Update the connector draft filtering validation. + * <p> + * Update the draft filtering validation info for a connector. * * @param fn * a function that initializes a builder to create the * {@link UpdateFilteringValidationRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-filtering-validation-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-filtering-validation-api.html">Documentation * on elastic.co</a> */ @@ -701,10 +816,13 @@ public final UpdateFilteringValidationResponse updateFilteringValidation( // ----- Endpoint: connector.update_index_name /** - * Updates the index_name in the connector document + * Update the connector index name. + * <p> + * Update the <code>index_name</code> field of a connector, specifying the index + * where the data ingested by the connector is stored. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-index-name-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-index-name-api.html">Documentation * on elastic.co</a> */ @@ -717,13 +835,16 @@ public UpdateIndexNameResponse updateIndexName(UpdateIndexNameRequest request) } /** - * Updates the index_name in the connector document + * Update the connector index name. + * <p> + * Update the <code>index_name</code> field of a connector, specifying the index + * where the data ingested by the connector is stored. * * @param fn * a function that initializes a builder to create the * {@link UpdateIndexNameRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-index-name-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-index-name-api.html">Documentation * on elastic.co</a> */ @@ -736,10 +857,10 @@ public final UpdateIndexNameResponse updateIndexName( // ----- Endpoint: connector.update_name /** - * Updates the name and description fields in the connector document + * Update the connector name and description. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-name-description-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-name-description-api.html">Documentation * on elastic.co</a> */ @@ -751,13 +872,13 @@ public UpdateNameResponse updateName(UpdateNameRequest request) throws IOExcepti } /** - * Updates the name and description fields in the connector document + * Update the connector name and description. * * @param fn * a function that initializes a builder to create the * {@link UpdateNameRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-name-description-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-name-description-api.html">Documentation * on elastic.co</a> */ @@ -769,10 +890,10 @@ public final UpdateNameResponse updateName(Function<UpdateNameRequest.Builder, O // ----- Endpoint: connector.update_native /** - * Updates the is_native flag in the connector document + * Update the connector is_native flag. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-native-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-native-api.html">Documentation * on elastic.co</a> */ @@ -784,13 +905,13 @@ public UpdateNativeResponse updateNative(UpdateNativeRequest request) throws IOE } /** - * Updates the is_native flag in the connector document + * Update the connector is_native flag. * * @param fn * a function that initializes a builder to create the * {@link UpdateNativeRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-native-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-native-api.html">Documentation * on elastic.co</a> */ @@ -803,10 +924,13 @@ public final UpdateNativeResponse updateNative( // ----- Endpoint: connector.update_pipeline /** - * Updates the pipeline field in the connector document + * Update the connector pipeline. + * <p> + * When you create a new connector, the configuration of an ingest pipeline is + * populated with default settings. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-pipeline-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-pipeline-api.html">Documentation * on elastic.co</a> */ @@ -819,13 +943,16 @@ public UpdatePipelineResponse updatePipeline(UpdatePipelineRequest request) } /** - * Updates the pipeline field in the connector document + * Update the connector pipeline. + * <p> + * When you create a new connector, the configuration of an ingest pipeline is + * populated with default settings. * * @param fn * a function that initializes a builder to create the * {@link UpdatePipelineRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-pipeline-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-pipeline-api.html">Documentation * on elastic.co</a> */ @@ -838,10 +965,10 @@ public final UpdatePipelineResponse updatePipeline( // ----- Endpoint: connector.update_scheduling /** - * Updates the scheduling field in the connector document + * Update the connector scheduling. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-scheduling-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-scheduling-api.html">Documentation * on elastic.co</a> */ @@ -854,13 +981,13 @@ public UpdateSchedulingResponse updateScheduling(UpdateSchedulingRequest request } /** - * Updates the scheduling field in the connector document + * Update the connector scheduling. * * @param fn * a function that initializes a builder to create the * {@link UpdateSchedulingRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-scheduling-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-scheduling-api.html">Documentation * on elastic.co</a> */ @@ -873,10 +1000,10 @@ public final UpdateSchedulingResponse updateScheduling( // ----- Endpoint: connector.update_service_type /** - * Updates the service type of the connector + * Update the connector service type. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-service-type-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-service-type-api.html">Documentation * on elastic.co</a> */ @@ -889,13 +1016,13 @@ public UpdateServiceTypeResponse updateServiceType(UpdateServiceTypeRequest requ } /** - * Updates the service type of the connector + * Update the connector service type. * * @param fn * a function that initializes a builder to create the * {@link UpdateServiceTypeRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-service-type-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-service-type-api.html">Documentation * on elastic.co</a> */ @@ -908,10 +1035,10 @@ public final UpdateServiceTypeResponse updateServiceType( // ----- Endpoint: connector.update_status /** - * Updates the status of the connector + * Update the connector status. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-status-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-status-api.html">Documentation * on elastic.co</a> */ @@ -923,13 +1050,13 @@ public UpdateStatusResponse updateStatus(UpdateStatusRequest request) throws IOE } /** - * Updates the status of the connector + * Update the connector status. * * @param fn * a function that initializes a builder to create the * {@link UpdateStatusRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-status-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-status-api.html">Documentation * on elastic.co</a> */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/FilteringAdvancedSnippet.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/FilteringAdvancedSnippet.java index a36839618..a6da3d5c1 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/FilteringAdvancedSnippet.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/FilteringAdvancedSnippet.java @@ -32,8 +32,6 @@ import co.elastic.clients.util.ObjectBuilder; import co.elastic.clients.util.WithJsonObjectBuilderBase; import jakarta.json.stream.JsonGenerator; -import java.lang.String; -import java.util.Map; import java.util.Objects; import java.util.function.Function; import javax.annotation.Nullable; @@ -69,7 +67,7 @@ public class FilteringAdvancedSnippet implements JsonpSerializable { @Nullable private final DateTime updatedAt; - private final Map<String, JsonData> value; + private final JsonData value; // --------------------------------------------------------------------------------------------- @@ -77,7 +75,7 @@ private FilteringAdvancedSnippet(Builder builder) { this.createdAt = builder.createdAt; this.updatedAt = builder.updatedAt; - this.value = ApiTypeHelper.unmodifiableRequired(builder.value, this, "value"); + this.value = ApiTypeHelper.requireNonNull(builder.value, this, "value"); } @@ -104,7 +102,7 @@ public final DateTime updatedAt() { /** * Required - API name: {@code value} */ - public final Map<String, JsonData> value() { + public final JsonData value() { return this.value; } @@ -127,17 +125,8 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) { generator.writeKey("updated_at"); this.updatedAt.serialize(generator, mapper); } - if (ApiTypeHelper.isDefined(this.value)) { - generator.writeKey("value"); - generator.writeStartObject(); - for (Map.Entry<String, JsonData> item0 : this.value.entrySet()) { - generator.writeKey(item0.getKey()); - item0.getValue().serialize(generator, mapper); - - } - generator.writeEnd(); - - } + generator.writeKey("value"); + this.value.serialize(generator, mapper); } @@ -161,7 +150,7 @@ public static class Builder extends WithJsonObjectBuilderBase<Builder> @Nullable private DateTime updatedAt; - private Map<String, JsonData> value; + private JsonData value; /** * API name: {@code created_at} @@ -181,21 +170,9 @@ public final Builder updatedAt(@Nullable DateTime value) { /** * Required - API name: {@code value} - * <p> - * Adds all entries of <code>map</code> to <code>value</code>. - */ - public final Builder value(Map<String, JsonData> map) { - this.value = _mapPutAll(this.value, map); - return this; - } - - /** - * Required - API name: {@code value} - * <p> - * Adds an entry to <code>value</code>. */ - public final Builder value(String key, JsonData value) { - this.value = _mapPut(this.value, key, value); + public final Builder value(JsonData value) { + this.value = value; return this; } @@ -230,7 +207,7 @@ protected static void setupFilteringAdvancedSnippetDeserializer( op.add(Builder::createdAt, DateTime._DESERIALIZER, "created_at"); op.add(Builder::updatedAt, DateTime._DESERIALIZER, "updated_at"); - op.add(Builder::value, JsonpDeserializer.stringMapDeserializer(JsonData._DESERIALIZER), "value"); + op.add(Builder::value, JsonData._DESERIALIZER, "value"); } diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/GetConnectorRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/GetConnectorRequest.java index 9d9cd9328..400a33927 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/GetConnectorRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/GetConnectorRequest.java @@ -56,7 +56,9 @@ // typedef: connector.get.Request /** - * Retrieves a connector. + * Get a connector. + * <p> + * Get the details about a connector. * * @see <a href="../doc-files/api-spec.html#connector.get.Request">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/ListRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/ListRequest.java index c290e19f7..439c4094d 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/ListRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/ListRequest.java @@ -59,7 +59,9 @@ // typedef: connector.list.Request /** - * Returns existing connectors. + * Get all connectors. + * <p> + * Get information about all connectors. * * @see <a href="../doc-files/api-spec.html#connector.list.Request">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/PostRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/PostRequest.java index 2f34ed80d..962e1cf70 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/PostRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/PostRequest.java @@ -56,7 +56,13 @@ // typedef: connector.post.Request /** - * Creates a connector. + * Create a connector. + * <p> + * Connectors are Elasticsearch integrations that bring content from third-party + * data sources, which can be deployed on Elastic Cloud or hosted on your own + * infrastructure. Elastic managed connectors (Native connectors) are a managed + * service on Elastic Cloud. Self-managed connectors (Connector clients) are + * self-managed on your infrastructure. * * @see <a href="../doc-files/api-spec.html#connector.post.Request">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/PutRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/PutRequest.java index 49ca6b6b2..1739c1daa 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/PutRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/PutRequest.java @@ -58,7 +58,7 @@ // typedef: connector.put.Request /** - * Creates or updates a connector. + * Create or update a connector. * * @see <a href="../doc-files/api-spec.html#connector.put.Request">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/SyncJobCancelRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/SyncJobCancelRequest.java index d87926d47..650965a39 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/SyncJobCancelRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/SyncJobCancelRequest.java @@ -56,7 +56,12 @@ // typedef: connector.sync_job_cancel.Request /** - * Cancels a connector sync job. + * Cancel a connector sync job. + * <p> + * Cancel a connector sync job, which sets the status to cancelling and updates + * <code>cancellation_requested_at</code> to the current time. The connector + * service is then responsible for setting the status of connector sync jobs to + * cancelled. * * @see <a href= * "../doc-files/api-spec.html#connector.sync_job_cancel.Request">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/SyncJobDeleteRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/SyncJobDeleteRequest.java index 7fabf48c1..c2159eb88 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/SyncJobDeleteRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/SyncJobDeleteRequest.java @@ -56,7 +56,10 @@ // typedef: connector.sync_job_delete.Request /** - * Deletes a connector sync job. + * Delete a connector sync job. + * <p> + * Remove a connector sync job and its associated data. This is a destructive + * action that is not recoverable. * * @see <a href= * "../doc-files/api-spec.html#connector.sync_job_delete.Request">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/SyncJobGetRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/SyncJobGetRequest.java index 16bb24995..09502a164 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/SyncJobGetRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/SyncJobGetRequest.java @@ -56,7 +56,7 @@ // typedef: connector.sync_job_get.Request /** - * Retrieves a connector sync job. + * Get a connector sync job. * * @see <a href="../doc-files/api-spec.html#connector.sync_job_get.Request">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/SyncJobListRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/SyncJobListRequest.java index 884e96a94..2333c2e99 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/SyncJobListRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/SyncJobListRequest.java @@ -59,7 +59,10 @@ // typedef: connector.sync_job_list.Request /** - * Lists connector sync jobs. + * Get all connector sync jobs. + * <p> + * Get information about all stored connector sync jobs listed by their creation + * date in ascending order. * * @see <a href="../doc-files/api-spec.html#connector.sync_job_list.Request">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/SyncJobPostRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/SyncJobPostRequest.java index 88290cfea..3c9a52218 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/SyncJobPostRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/SyncJobPostRequest.java @@ -56,7 +56,10 @@ // typedef: connector.sync_job_post.Request /** - * Creates a connector sync job. + * Create a connector sync job. + * <p> + * Create a connector sync job document in the internal index and initialize its + * counters and timestamps with default values. * * @see <a href="../doc-files/api-spec.html#connector.sync_job_post.Request">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateActiveFilteringRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateActiveFilteringRequest.java index 518494566..be2006402 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateActiveFilteringRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateActiveFilteringRequest.java @@ -56,6 +56,8 @@ // typedef: connector.update_active_filtering.Request /** + * Activate the connector draft filter. + * <p> * Activates the valid draft filtering for a connector. * * @see <a href= diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateApiKeyIdRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateApiKeyIdRequest.java index ec1beb3a5..2b956152b 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateApiKeyIdRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateApiKeyIdRequest.java @@ -58,7 +58,13 @@ // typedef: connector.update_api_key_id.Request /** - * Updates the API key id in the connector document + * Update the connector API key ID. + * <p> + * Update the <code>api_key_id</code> and <code>api_key_secret_id</code> fields + * of a connector. You can specify the ID of the API key used for authorization + * and the ID of the connector secret where the API key is stored. The connector + * secret ID is required only for Elastic managed (native) connectors. + * Self-managed connectors (connector clients) do not use this field. * * @see <a href= * "../doc-files/api-spec.html#connector.update_api_key_id.Request">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateConfigurationRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateConfigurationRequest.java index 0c5965cae..350d1a191 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateConfigurationRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateConfigurationRequest.java @@ -59,7 +59,9 @@ // typedef: connector.update_configuration.Request /** - * Updates the configuration field in the connector document + * Update the connector configuration. + * <p> + * Update the configuration field in the connector document. * * @see <a href= * "../doc-files/api-spec.html#connector.update_configuration.Request">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateErrorRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateErrorRequest.java index f4d02d753..94160d95e 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateErrorRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateErrorRequest.java @@ -59,7 +59,11 @@ // typedef: connector.update_error.Request /** - * Updates the filtering field in the connector document + * Update the connector error field. + * <p> + * Set the error field for the connector. If the error provided in the request + * body is non-null, the connector’s status is updated to error. Otherwise, if + * the error is reset to null, the connector status is updated to connected. * * @see <a href="../doc-files/api-spec.html#connector.update_error.Request">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateFilteringRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateFilteringRequest.java index a3d636dae..d4b38507a 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateFilteringRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateFilteringRequest.java @@ -59,7 +59,12 @@ // typedef: connector.update_filtering.Request /** - * Updates the filtering field in the connector document + * Update the connector filtering. + * <p> + * Update the draft filtering configuration of a connector and marks the draft + * validation state as edited. The filtering draft is activated once validated + * by the running Elastic connector service. The filtering property is used to + * configure sync rules (both basic and advanced) for a connector. * * @see <a href= * "../doc-files/api-spec.html#connector.update_filtering.Request">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateFilteringValidationRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateFilteringValidationRequest.java index 4c204e883..3744cd701 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateFilteringValidationRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateFilteringValidationRequest.java @@ -58,7 +58,9 @@ // typedef: connector.update_filtering_validation.Request /** - * Updates the draft filtering validation info for a connector. + * Update the connector draft filtering validation. + * <p> + * Update the draft filtering validation info for a connector. * * @see <a href= * "../doc-files/api-spec.html#connector.update_filtering_validation.Request">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateIndexNameRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateIndexNameRequest.java index 42cd58058..b4244c940 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateIndexNameRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateIndexNameRequest.java @@ -59,7 +59,10 @@ // typedef: connector.update_index_name.Request /** - * Updates the index_name in the connector document + * Update the connector index name. + * <p> + * Update the <code>index_name</code> field of a connector, specifying the index + * where the data ingested by the connector is stored. * * @see <a href= * "../doc-files/api-spec.html#connector.update_index_name.Request">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateNameRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateNameRequest.java index 12c5bf4dd..c446d81c6 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateNameRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateNameRequest.java @@ -58,7 +58,7 @@ // typedef: connector.update_name.Request /** - * Updates the name and description fields in the connector document + * Update the connector name and description. * * @see <a href="../doc-files/api-spec.html#connector.update_name.Request">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateNativeRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateNativeRequest.java index 728a5783b..e3e03e486 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateNativeRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateNativeRequest.java @@ -59,7 +59,7 @@ // typedef: connector.update_native.Request /** - * Updates the is_native flag in the connector document + * Update the connector is_native flag. * * @see <a href="../doc-files/api-spec.html#connector.update_native.Request">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdatePipelineRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdatePipelineRequest.java index 8c77a6354..adf382880 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdatePipelineRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdatePipelineRequest.java @@ -58,7 +58,10 @@ // typedef: connector.update_pipeline.Request /** - * Updates the pipeline field in the connector document + * Update the connector pipeline. + * <p> + * When you create a new connector, the configuration of an ingest pipeline is + * populated with default settings. * * @see <a href= * "../doc-files/api-spec.html#connector.update_pipeline.Request">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateSchedulingRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateSchedulingRequest.java index 6fc8be6e4..0a5a834b6 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateSchedulingRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateSchedulingRequest.java @@ -58,7 +58,7 @@ // typedef: connector.update_scheduling.Request /** - * Updates the scheduling field in the connector document + * Update the connector scheduling. * * @see <a href= * "../doc-files/api-spec.html#connector.update_scheduling.Request">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateServiceTypeRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateServiceTypeRequest.java index 9e7c93ee8..58d700966 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateServiceTypeRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateServiceTypeRequest.java @@ -58,7 +58,7 @@ // typedef: connector.update_service_type.Request /** - * Updates the service type of the connector + * Update the connector service type. * * @see <a href= * "../doc-files/api-spec.html#connector.update_service_type.Request">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateStatusRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateStatusRequest.java index 5f0b7270f..1e3a4c6c2 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateStatusRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/UpdateStatusRequest.java @@ -58,7 +58,7 @@ // typedef: connector.update_status.Request /** - * Updates the status of the connector + * Update the connector status. * * @see <a href="../doc-files/api-spec.html#connector.update_status.Request">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/GetScriptContextRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/GetScriptContextRequest.java index 1c6081543..b86044ce0 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/GetScriptContextRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/GetScriptContextRequest.java @@ -50,7 +50,9 @@ // typedef: _global.get_script_context.Request /** - * Returns all script contexts. + * Get script contexts. + * <p> + * Get a list of supported script contexts and their methods. * * @see <a href= * "../doc-files/api-spec.html#_global.get_script_context.Request">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/GetScriptLanguagesRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/GetScriptLanguagesRequest.java index 759ad87f6..441e8e2b6 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/GetScriptLanguagesRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/GetScriptLanguagesRequest.java @@ -50,7 +50,9 @@ // typedef: _global.get_script_languages.Request /** - * Returns available script types, languages and contexts + * Get script languages. + * <p> + * Get a list of available script types, languages, and contexts. * * @see <a href= * "../doc-files/api-spec.html#_global.get_script_languages.Request">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/MsearchRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/MsearchRequest.java index a73479dbd..5116f9f72 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/MsearchRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/MsearchRequest.java @@ -66,7 +66,27 @@ // typedef: _global.msearch.Request /** - * 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="../doc-files/api-spec.html#_global.msearch.Request">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/ScrollRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/ScrollRequest.java index 9a1acc6b4..440f2039b 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/ScrollRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/ScrollRequest.java @@ -57,7 +57,29 @@ // typedef: _global.scroll.Request /** - * 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="../doc-files/api-spec.html#_global.scroll.Request">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/TermsEnumRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/TermsEnumRequest.java index 19e3a9b66..8e9c8adad 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/TermsEnumRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/TermsEnumRequest.java @@ -62,9 +62,20 @@ // typedef: _global.terms_enum.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 "terms + * enum" 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="../doc-files/api-spec.html#_global.terms_enum.Request">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/rank_eval/RankEvalMetricDiscountedCumulativeGain.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/rank_eval/RankEvalMetricDiscountedCumulativeGain.java index fb4b7dcf4..f63da469b 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/rank_eval/RankEvalMetricDiscountedCumulativeGain.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/rank_eval/RankEvalMetricDiscountedCumulativeGain.java @@ -52,7 +52,7 @@ * Discounted cumulative gain (DCG) * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/search-rank-eval.html#_discounted_cumulative_gain_dcg">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-rank-eval.html#_discounted_cumulative_gain_dcg">Documentation * on elastic.co</a> * @see <a href= * "../../doc-files/api-spec.html#_global.rank_eval.RankEvalMetricDiscountedCumulativeGain">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/rank_eval/RankEvalMetricExpectedReciprocalRank.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/rank_eval/RankEvalMetricExpectedReciprocalRank.java index 49f431158..8fd9ff514 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/rank_eval/RankEvalMetricExpectedReciprocalRank.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/rank_eval/RankEvalMetricExpectedReciprocalRank.java @@ -52,7 +52,7 @@ * Expected Reciprocal Rank (ERR) * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/search-rank-eval.html#_expected_reciprocal_rank_err">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-rank-eval.html#_expected_reciprocal_rank_err">Documentation * on elastic.co</a> * @see <a href= * "../../doc-files/api-spec.html#_global.rank_eval.RankEvalMetricExpectedReciprocalRank">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/rank_eval/RankEvalMetricMeanReciprocalRank.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/rank_eval/RankEvalMetricMeanReciprocalRank.java index 53c94229e..74f274d08 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/rank_eval/RankEvalMetricMeanReciprocalRank.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/rank_eval/RankEvalMetricMeanReciprocalRank.java @@ -49,7 +49,7 @@ * Mean Reciprocal Rank * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/search-rank-eval.html#_mean_reciprocal_rank">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-rank-eval.html#_mean_reciprocal_rank">Documentation * on elastic.co</a> * @see <a href= * "../../doc-files/api-spec.html#_global.rank_eval.RankEvalMetricMeanReciprocalRank">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/rank_eval/RankEvalMetricPrecision.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/rank_eval/RankEvalMetricPrecision.java index 0bccc4647..c9398e3d4 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/rank_eval/RankEvalMetricPrecision.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/rank_eval/RankEvalMetricPrecision.java @@ -52,7 +52,7 @@ * Precision at K (P@k) * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/search-rank-eval.html#k-precision">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-rank-eval.html#k-precision">Documentation * on elastic.co</a> * @see <a href= * "../../doc-files/api-spec.html#_global.rank_eval.RankEvalMetricPrecision">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/rank_eval/RankEvalMetricRecall.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/rank_eval/RankEvalMetricRecall.java index f6fc81e82..62c616f5a 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/rank_eval/RankEvalMetricRecall.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/rank_eval/RankEvalMetricRecall.java @@ -49,7 +49,7 @@ * Recall at K (R@k) * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/search-rank-eval.html#k-recall">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-rank-eval.html#k-recall">Documentation * on elastic.co</a> * @see <a href= * "../../doc-files/api-spec.html#_global.rank_eval.RankEvalMetricRecall">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/search/Context.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/search/Context.java index c0c2d8be2..2f29dd79b 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/search/Context.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/search/Context.java @@ -62,7 +62,7 @@ * document's field for the text. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/query-dsl-mlt-query.html#_document_input_parameters">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/query-dsl-mlt-query.html#_document_input_parameters">Documentation * on elastic.co</a> * @see <a href= * "../../doc-files/api-spec.html#_global.search._types.Context">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/dangling_indices/DeleteDanglingIndexRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/dangling_indices/DeleteDanglingIndexRequest.java index 8f87222e0..f0995034d 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/dangling_indices/DeleteDanglingIndexRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/dangling_indices/DeleteDanglingIndexRequest.java @@ -57,7 +57,13 @@ // typedef: dangling_indices.delete_dangling_index.Request /** - * Deletes the specified dangling index + * Delete a dangling index. + * <p> + * If Elasticsearch encounters index data that is absent from the current + * cluster state, those indices are considered to be dangling. For example, this + * can happen if you delete more than + * <code>cluster.indices.tombstones.size</code> indices while an Elasticsearch + * node is offline. * * @see <a href= * "../doc-files/api-spec.html#dangling_indices.delete_dangling_index.Request">API @@ -91,7 +97,8 @@ public static DeleteDanglingIndexRequest of(Function<Builder, ObjectBuilder<Dele } /** - * Required - Must be set to true in order to delete the dangling index + * Required - This parameter must be set to true to acknowledge that it will no + * longer be possible to recove data from the dangling index. * <p> * API name: {@code accept_data_loss} */ @@ -100,7 +107,8 @@ public final boolean acceptDataLoss() { } /** - * Required - The UUID of the dangling index + * Required - The UUID of the index to delete. Use the get dangling indices API + * to find the UUID. * <p> * API name: {@code index_uuid} */ @@ -148,7 +156,8 @@ public static class Builder extends RequestBase.AbstractBuilder<Builder> private Time timeout; /** - * Required - Must be set to true in order to delete the dangling index + * Required - This parameter must be set to true to acknowledge that it will no + * longer be possible to recove data from the dangling index. * <p> * API name: {@code accept_data_loss} */ @@ -158,7 +167,8 @@ public final Builder acceptDataLoss(boolean value) { } /** - * Required - The UUID of the dangling index + * Required - The UUID of the index to delete. Use the get dangling indices API + * to find the UUID. * <p> * API name: {@code index_uuid} */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/dangling_indices/ElasticsearchDanglingIndicesAsyncClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/dangling_indices/ElasticsearchDanglingIndicesAsyncClient.java index 5999055f0..9399da94c 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/dangling_indices/ElasticsearchDanglingIndicesAsyncClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/dangling_indices/ElasticsearchDanglingIndicesAsyncClient.java @@ -70,7 +70,13 @@ public ElasticsearchDanglingIndicesAsyncClient withTransportOptions(@Nullable Tr // ----- Endpoint: dangling_indices.delete_dangling_index /** - * Deletes the specified dangling index + * Delete a dangling index. + * <p> + * If Elasticsearch encounters index data that is absent from the current + * cluster state, those indices are considered to be dangling. For example, this + * can happen if you delete more than + * <code>cluster.indices.tombstones.size</code> indices while an Elasticsearch + * node is offline. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html">Documentation @@ -85,7 +91,13 @@ public CompletableFuture<DeleteDanglingIndexResponse> deleteDanglingIndex(Delete } /** - * Deletes the specified dangling index + * Delete a dangling index. + * <p> + * If Elasticsearch encounters index data that is absent from the current + * cluster state, those indices are considered to be dangling. For example, this + * can happen if you delete more than + * <code>cluster.indices.tombstones.size</code> indices while an Elasticsearch + * node is offline. * * @param fn * a function that initializes a builder to create the @@ -103,7 +115,13 @@ public final CompletableFuture<DeleteDanglingIndexResponse> deleteDanglingIndex( // ----- Endpoint: dangling_indices.import_dangling_index /** - * Imports the specified dangling index + * Import a dangling index. + * <p> + * If Elasticsearch encounters index data that is absent from the current + * cluster state, those indices are considered to be dangling. For example, this + * can happen if you delete more than + * <code>cluster.indices.tombstones.size</code> indices while an Elasticsearch + * node is offline. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html">Documentation @@ -118,7 +136,13 @@ public CompletableFuture<ImportDanglingIndexResponse> importDanglingIndex(Import } /** - * Imports the specified dangling index + * Import a dangling index. + * <p> + * If Elasticsearch encounters index data that is absent from the current + * cluster state, those indices are considered to be dangling. For example, this + * can happen if you delete more than + * <code>cluster.indices.tombstones.size</code> indices while an Elasticsearch + * node is offline. * * @param fn * a function that initializes a builder to create the @@ -136,7 +160,15 @@ public final CompletableFuture<ImportDanglingIndexResponse> importDanglingIndex( // ----- Endpoint: dangling_indices.list_dangling_indices /** - * Returns all dangling indices. + * Get the dangling indices. + * <p> + * If Elasticsearch encounters index data that is absent from the current + * cluster state, those indices are considered to be dangling. For example, this + * can happen if you delete more than + * <code>cluster.indices.tombstones.size</code> indices while an Elasticsearch + * node is offline. + * <p> + * Use this API to list dangling indices, which you can then import or delete. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html">Documentation diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/dangling_indices/ElasticsearchDanglingIndicesClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/dangling_indices/ElasticsearchDanglingIndicesClient.java index c6b15b641..dd146a73a 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/dangling_indices/ElasticsearchDanglingIndicesClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/dangling_indices/ElasticsearchDanglingIndicesClient.java @@ -71,7 +71,13 @@ public ElasticsearchDanglingIndicesClient withTransportOptions(@Nullable Transpo // ----- Endpoint: dangling_indices.delete_dangling_index /** - * Deletes the specified dangling index + * Delete a dangling index. + * <p> + * If Elasticsearch encounters index data that is absent from the current + * cluster state, those indices are considered to be dangling. For example, this + * can happen if you delete more than + * <code>cluster.indices.tombstones.size</code> indices while an Elasticsearch + * node is offline. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html">Documentation @@ -87,7 +93,13 @@ public DeleteDanglingIndexResponse deleteDanglingIndex(DeleteDanglingIndexReques } /** - * Deletes the specified dangling index + * Delete a dangling index. + * <p> + * If Elasticsearch encounters index data that is absent from the current + * cluster state, those indices are considered to be dangling. For example, this + * can happen if you delete more than + * <code>cluster.indices.tombstones.size</code> indices while an Elasticsearch + * node is offline. * * @param fn * a function that initializes a builder to create the @@ -106,7 +118,13 @@ public final DeleteDanglingIndexResponse deleteDanglingIndex( // ----- Endpoint: dangling_indices.import_dangling_index /** - * Imports the specified dangling index + * Import a dangling index. + * <p> + * If Elasticsearch encounters index data that is absent from the current + * cluster state, those indices are considered to be dangling. For example, this + * can happen if you delete more than + * <code>cluster.indices.tombstones.size</code> indices while an Elasticsearch + * node is offline. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html">Documentation @@ -122,7 +140,13 @@ public ImportDanglingIndexResponse importDanglingIndex(ImportDanglingIndexReques } /** - * Imports the specified dangling index + * Import a dangling index. + * <p> + * If Elasticsearch encounters index data that is absent from the current + * cluster state, those indices are considered to be dangling. For example, this + * can happen if you delete more than + * <code>cluster.indices.tombstones.size</code> indices while an Elasticsearch + * node is offline. * * @param fn * a function that initializes a builder to create the @@ -141,7 +165,15 @@ public final ImportDanglingIndexResponse importDanglingIndex( // ----- Endpoint: dangling_indices.list_dangling_indices /** - * Returns all dangling indices. + * Get the dangling indices. + * <p> + * If Elasticsearch encounters index data that is absent from the current + * cluster state, those indices are considered to be dangling. For example, this + * can happen if you delete more than + * <code>cluster.indices.tombstones.size</code> indices while an Elasticsearch + * node is offline. + * <p> + * Use this API to list dangling indices, which you can then import or delete. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html">Documentation diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/dangling_indices/ImportDanglingIndexRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/dangling_indices/ImportDanglingIndexRequest.java index acb5a9d15..b6e7c4d81 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/dangling_indices/ImportDanglingIndexRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/dangling_indices/ImportDanglingIndexRequest.java @@ -57,7 +57,13 @@ // typedef: dangling_indices.import_dangling_index.Request /** - * Imports the specified dangling index + * Import a dangling index. + * <p> + * If Elasticsearch encounters index data that is absent from the current + * cluster state, those indices are considered to be dangling. For example, this + * can happen if you delete more than + * <code>cluster.indices.tombstones.size</code> indices while an Elasticsearch + * node is offline. * * @see <a href= * "../doc-files/api-spec.html#dangling_indices.import_dangling_index.Request">API @@ -91,7 +97,11 @@ public static ImportDanglingIndexRequest of(Function<Builder, ObjectBuilder<Impo } /** - * Required - Must be set to true in order to import the dangling index + * Required - This parameter must be set to true to import a dangling index. + * Because Elasticsearch cannot know where the dangling index data came from or + * determine which shard copies are fresh and which are stale, it cannot + * guarantee that the imported data represents the latest state of the index + * when it was last in the cluster. * <p> * API name: {@code accept_data_loss} */ @@ -100,7 +110,8 @@ public final boolean acceptDataLoss() { } /** - * Required - The UUID of the dangling index + * Required - The UUID of the index to import. Use the get dangling indices API + * to locate the UUID. * <p> * API name: {@code index_uuid} */ @@ -148,7 +159,11 @@ public static class Builder extends RequestBase.AbstractBuilder<Builder> private Time timeout; /** - * Required - Must be set to true in order to import the dangling index + * Required - This parameter must be set to true to import a dangling index. + * Because Elasticsearch cannot know where the dangling index data came from or + * determine which shard copies are fresh and which are stale, it cannot + * guarantee that the imported data represents the latest state of the index + * when it was last in the cluster. * <p> * API name: {@code accept_data_loss} */ @@ -158,7 +173,8 @@ public final Builder acceptDataLoss(boolean value) { } /** - * Required - The UUID of the dangling index + * Required - The UUID of the index to import. Use the get dangling indices API + * to locate the UUID. * <p> * API name: {@code index_uuid} */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/dangling_indices/ListDanglingIndicesRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/dangling_indices/ListDanglingIndicesRequest.java index 4ac366cc2..079fc622f 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/dangling_indices/ListDanglingIndicesRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/dangling_indices/ListDanglingIndicesRequest.java @@ -50,7 +50,15 @@ // typedef: dangling_indices.list_dangling_indices.Request /** - * Returns all dangling indices. + * Get the dangling indices. + * <p> + * If Elasticsearch encounters index data that is absent from the current + * cluster state, those indices are considered to be dangling. For example, this + * can happen if you delete more than + * <code>cluster.indices.tombstones.size</code> indices while an Elasticsearch + * node is offline. + * <p> + * Use this API to list dangling indices, which you can then import or delete. * * @see <a href= * "../doc-files/api-spec.html#dangling_indices.list_dangling_indices.Request">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/doc-files/api-spec.html b/java-client/src/main/java/co/elastic/clients/elasticsearch/doc-files/api-spec.html index a6ccbc27f..f4310f236 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/doc-files/api-spec.html +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/doc-files/api-spec.html @@ -49,10 +49,10 @@ '_global.get_script_context.Context': '_global/get_script_context/types.ts#L22-L25', '_global.get_script_context.ContextMethod': '_global/get_script_context/types.ts#L27-L31', '_global.get_script_context.ContextMethodParam': '_global/get_script_context/types.ts#L33-L36', -'_global.get_script_context.Request': '_global/get_script_context/GetScriptContextRequest.ts#L22-L26', +'_global.get_script_context.Request': '_global/get_script_context/GetScriptContextRequest.ts#L22-L30', '_global.get_script_context.Response': '_global/get_script_context/GetScriptContextResponse.ts#L22-L26', '_global.get_script_languages.LanguageContext': '_global/get_script_languages/types.ts#L22-L25', -'_global.get_script_languages.Request': '_global/get_script_languages/GetScriptLanguagesRequest.ts#L22-L26', +'_global.get_script_languages.Request': '_global/get_script_languages/GetScriptLanguagesRequest.ts#L22-L30', '_global.get_script_languages.Response': '_global/get_script_languages/GetScriptLanguagesResponse.ts#L22-L27', '_global.get_source.Request': '_global/get_source/SourceRequest.ts#L31-L89', '_global.get_source.Response': '_global/get_source/SourceResponse.ts#L20-L23', @@ -91,7 +91,7 @@ '_global.index.Response': '_global/index/IndexResponse.ts#L22-L24', '_global.info.Request': '_global/info/RootNodeInfoRequest.ts#L22-L29', '_global.info.Response': '_global/info/RootNodeInfoResponse.ts#L23-L31', -'_global.knn_search.Request': '_global/knn_search/KnnSearchRequest.ts#L26-L80', +'_global.knn_search.Request': '_global/knn_search/KnnSearchRequest.ts#L26-L83', '_global.knn_search.Response': '_global/knn_search/KnnSearchResponse.ts#L26-L54', '_global.knn_search._types.Query': '_global/knn_search/_types/Knn.ts#L24-L33', '_global.mget.MultiGetError': '_global/mget/types.ts#L62-L66', @@ -99,13 +99,13 @@ '_global.mget.Request': '_global/mget/MultiGetRequest.ts#L25-L98', '_global.mget.Response': '_global/mget/MultiGetResponse.ts#L22-L26', '_global.mget.ResponseItem': '_global/mget/types.ts#L57-L60', -'_global.msearch.MultiSearchItem': '_global/msearch/types.ts#L213-L216', -'_global.msearch.MultiSearchResult': '_global/msearch/types.ts#L203-L206', -'_global.msearch.MultisearchBody': '_global/msearch/types.ts#L70-L201', +'_global.msearch.MultiSearchItem': '_global/msearch/types.ts#L216-L219', +'_global.msearch.MultiSearchResult': '_global/msearch/types.ts#L206-L209', +'_global.msearch.MultisearchBody': '_global/msearch/types.ts#L70-L204', '_global.msearch.MultisearchHeader': '_global/msearch/types.ts#L52-L67', -'_global.msearch.Request': '_global/msearch/MultiSearchRequest.ts#L25-L106', +'_global.msearch.Request': '_global/msearch/MultiSearchRequest.ts#L25-L124', '_global.msearch.Response': '_global/msearch/MultiSearchResponse.ts#L25-L27', -'_global.msearch.ResponseItem': '_global/msearch/types.ts#L208-L211', +'_global.msearch.ResponseItem': '_global/msearch/types.ts#L211-L214', '_global.msearch_template.Request': '_global/msearch_template/MultiSearchTemplateRequest.ts#L25-L71', '_global.msearch_template.Response': '_global/msearch_template/MultiSearchTemplateResponse.ts#L22-L24', '_global.msearch_template.TemplateConfig': '_global/msearch_template/types.ts#L28-L54', @@ -150,7 +150,7 @@ '_global.scripts_painless_execute.PainlessContextSetup': '_global/scripts_painless_execute/types.ts#L25-L39', '_global.scripts_painless_execute.Request': '_global/scripts_painless_execute/ExecutePainlessScriptRequest.ts#L24-L48', '_global.scripts_painless_execute.Response': '_global/scripts_painless_execute/ExecutePainlessScriptResponse.ts#L20-L24', -'_global.scroll.Request': '_global/scroll/ScrollRequest.ts#L24-L59', +'_global.scroll.Request': '_global/scroll/ScrollRequest.ts#L24-L75', '_global.scroll.Response': '_global/scroll/ScrollResponse.ts#L22-L24', '_global.search.Request': '_global/search/SearchRequest.ts#L54-L529', '_global.search.Response': '_global/search/SearchResponse.ts#L34-L36', @@ -174,7 +174,7 @@ '_global.search._types.FetchProfile': '_global/search/_types/profile.ts#L230-L237', '_global.search._types.FetchProfileBreakdown': '_global/search/_types/profile.ts#L239-L248', '_global.search._types.FetchProfileDebug': '_global/search/_types/profile.ts#L250-L253', -'_global.search._types.FieldCollapse': '_global/search/_types/FieldCollapse.ts#L24-L38', +'_global.search._types.FieldCollapse': '_global/search/_types/FieldCollapse.ts#L24-L41', '_global.search._types.FieldSuggester': '_global/search/_types/suggester.ts#L109-L142', '_global.search._types.Highlight': '_global/search/_types/highlighting.ts#L152-L155', '_global.search._types.HighlightBase': '_global/search/_types/highlighting.ts#L47-L150', @@ -239,7 +239,7 @@ '_global.search_shards.ShardStoreIndex': '_global/search_shards/SearchShardsResponse.ts#L62-L65', '_global.search_template.Request': '_global/search_template/SearchTemplateRequest.ts#L32-L135', '_global.search_template.Response': '_global/search_template/SearchTemplateResponse.ts#L30-L48', -'_global.terms_enum.Request': '_global/terms_enum/TermsEnumRequest.ts#L26-L65', +'_global.terms_enum.Request': '_global/terms_enum/TermsEnumRequest.ts#L26-L75', '_global.terms_enum.Response': '_global/terms_enum/TermsEnumResponse.ts#L22-L28', '_global.termvectors.FieldStatistics': '_global/termvectors/types.ts#L28-L32', '_global.termvectors.Filter': '_global/termvectors/types.ts#L49-L86', @@ -301,7 +301,7 @@ '_types.IndicesOptions': '_types/common.ts#L336-L363', '_types.IndicesResponseBase': '_types/Base.ts#L87-L89', '_types.InlineGet': '_types/common.ts#L321-L334', -'_types.KnnQuery': '_types/Knn.ts#L54-L69', +'_types.KnnQuery': '_types/Knn.ts#L54-L72', '_types.KnnRetriever': '_types/Retriever.ts#L58-L71', '_types.KnnSearch': '_types/Knn.ts#L30-L52', '_types.LatLonGeoLocation': '_types/Geo.ts#L120-L129', @@ -317,7 +317,7 @@ '_types.OpType': '_types/common.ts#L256-L265', '_types.PluginStats': '_types/Stats.ts#L180-L190', '_types.QueryCacheStats': '_types/Stats.ts#L192-L226', -'_types.QueryVectorBuilder': '_types/Knn.ts#L71-L74', +'_types.QueryVectorBuilder': '_types/Knn.ts#L74-L77', '_types.RRFRetriever': '_types/Retriever.ts#L73-L80', '_types.RankBase': '_types/Rank.ts#L30-L30', '_types.RankContainer': '_types/Rank.ts#L22-L28', @@ -357,7 +357,7 @@ '_types.StoredScript': '_types/Scripting.ts#L47-L57', '_types.SuggestMode': '_types/common.ts#L283-L296', '_types.TaskFailure': '_types/Errors.ts#L68-L73', -'_types.TextEmbedding': '_types/Knn.ts#L76-L79', +'_types.TextEmbedding': '_types/Knn.ts#L79-L82', '_types.ThreadType': '_types/common.ts#L298-L304', '_types.TimeUnit': '_types/Time.ts#L69-L77', '_types.TopLeftBottomRightGeoBounds': '_types/Geo.ts#L161-L164', @@ -371,261 +371,261 @@ '_types.WarmerStats': '_types/Stats.ts#L407-L412', '_types.WktGeoBounds': '_types/Geo.ts#L150-L152', '_types.WriteResponseBase': '_types/Base.ts#L36-L45', -'_types.aggregations.AdjacencyMatrixAggregate': '_types/aggregations/Aggregate.ts#L578-L580', +'_types.aggregations.AdjacencyMatrixAggregate': '_types/aggregations/Aggregate.ts#L647-L652', '_types.aggregations.AdjacencyMatrixAggregation': '_types/aggregations/bucket.ts#L60-L70', -'_types.aggregations.AdjacencyMatrixBucket': '_types/aggregations/Aggregate.ts#L582-L584', -'_types.aggregations.Aggregate': '_types/aggregations/Aggregate.ts#L38-L124', -'_types.aggregations.AggregateBase': '_types/aggregations/Aggregate.ts#L135-L137', +'_types.aggregations.AdjacencyMatrixBucket': '_types/aggregations/Aggregate.ts#L654-L656', +'_types.aggregations.Aggregate': '_types/aggregations/Aggregate.ts#L38-L125', +'_types.aggregations.AggregateBase': '_types/aggregations/Aggregate.ts#L136-L138', '_types.aggregations.Aggregation': '_types/aggregations/Aggregation.ts#L20-L20', '_types.aggregations.AggregationContainer': '_types/aggregations/AggregationContainer.ts#L107-L533', -'_types.aggregations.AggregationRange': '_types/aggregations/bucket.ts#L679-L692', -'_types.aggregations.ArrayPercentilesItem': '_types/aggregations/Aggregate.ts#L161-L165', -'_types.aggregations.AutoDateHistogramAggregate': '_types/aggregations/Aggregate.ts#L359-L363', -'_types.aggregations.AutoDateHistogramAggregation': '_types/aggregations/bucket.ts#L72-L107', +'_types.aggregations.AggregationRange': '_types/aggregations/bucket.ts#L691-L704', +'_types.aggregations.ArrayPercentilesItem': '_types/aggregations/Aggregate.ts#L162-L166', +'_types.aggregations.AutoDateHistogramAggregate': '_types/aggregations/Aggregate.ts#L393-L400', +'_types.aggregations.AutoDateHistogramAggregation': '_types/aggregations/bucket.ts#L72-L110', '_types.aggregations.AverageAggregation': '_types/aggregations/metric.ts#L55-L55', -'_types.aggregations.AverageBucketAggregation': '_types/aggregations/pipeline.ts#L78-L78', -'_types.aggregations.AvgAggregate': '_types/aggregations/Aggregate.ts#L210-L211', -'_types.aggregations.BoxPlotAggregate': '_types/aggregations/Aggregate.ts#L721-L737', +'_types.aggregations.AverageBucketAggregation': '_types/aggregations/pipeline.ts#L78-L81', +'_types.aggregations.AvgAggregate': '_types/aggregations/Aggregate.ts#L218-L222', +'_types.aggregations.BoxPlotAggregate': '_types/aggregations/Aggregate.ts#L806-L825', '_types.aggregations.BoxplotAggregation': '_types/aggregations/metric.ts#L57-L62', '_types.aggregations.BucketAggregationBase': '_types/aggregations/bucket.ts#L53-L58', -'_types.aggregations.BucketCorrelationAggregation': '_types/aggregations/pipeline.ts#L129-L135', -'_types.aggregations.BucketCorrelationFunction': '_types/aggregations/pipeline.ts#L137-L142', -'_types.aggregations.BucketCorrelationFunctionCountCorrelation': '_types/aggregations/pipeline.ts#L144-L147', -'_types.aggregations.BucketCorrelationFunctionCountCorrelationIndicator': '_types/aggregations/pipeline.ts#L149-L167', -'_types.aggregations.BucketKsAggregation': '_types/aggregations/pipeline.ts#L94-L127', -'_types.aggregations.BucketMetricValueAggregate': '_types/aggregations/Aggregate.ts#L234-L237', +'_types.aggregations.BucketCorrelationAggregation': '_types/aggregations/pipeline.ts#L139-L146', +'_types.aggregations.BucketCorrelationFunction': '_types/aggregations/pipeline.ts#L148-L153', +'_types.aggregations.BucketCorrelationFunctionCountCorrelation': '_types/aggregations/pipeline.ts#L155-L158', +'_types.aggregations.BucketCorrelationFunctionCountCorrelationIndicator': '_types/aggregations/pipeline.ts#L160-L178', +'_types.aggregations.BucketKsAggregation': '_types/aggregations/pipeline.ts#L103-L137', +'_types.aggregations.BucketMetricValueAggregate': '_types/aggregations/Aggregate.ts#L250-L253', '_types.aggregations.BucketPathAggregation': '_types/aggregations/pipeline.ts#L31-L37', -'_types.aggregations.BucketScriptAggregation': '_types/aggregations/pipeline.ts#L80-L85', -'_types.aggregations.BucketSelectorAggregation': '_types/aggregations/pipeline.ts#L87-L92', -'_types.aggregations.BucketSortAggregation': '_types/aggregations/pipeline.ts#L169-L190', -'_types.aggregations.Buckets': '_types/aggregations/Aggregate.ts#L317-L326', +'_types.aggregations.BucketScriptAggregation': '_types/aggregations/pipeline.ts#L83-L91', +'_types.aggregations.BucketSelectorAggregation': '_types/aggregations/pipeline.ts#L93-L101', +'_types.aggregations.BucketSortAggregation': '_types/aggregations/pipeline.ts#L180-L204', +'_types.aggregations.Buckets': '_types/aggregations/Aggregate.ts#L346-L355', '_types.aggregations.BucketsPath': '_types/aggregations/pipeline.ts#L53-L59', -'_types.aggregations.CalendarInterval': '_types/aggregations/bucket.ts#L256-L273', -'_types.aggregations.CardinalityAggregate': '_types/aggregations/Aggregate.ts#L139-L142', +'_types.aggregations.CalendarInterval': '_types/aggregations/bucket.ts#L262-L279', +'_types.aggregations.CardinalityAggregate': '_types/aggregations/Aggregate.ts#L140-L143', '_types.aggregations.CardinalityAggregation': '_types/aggregations/metric.ts#L87-L99', '_types.aggregations.CardinalityExecutionMode': '_types/aggregations/metric.ts#L64-L85', -'_types.aggregations.CategorizeTextAggregation': '_types/aggregations/bucket.ts#L1081-L1145', -'_types.aggregations.CategorizeTextAnalyzer': '_types/aggregations/bucket.ts#L1147-L1150', -'_types.aggregations.ChiSquareHeuristic': '_types/aggregations/bucket.ts#L761-L770', -'_types.aggregations.ChildrenAggregate': '_types/aggregations/Aggregate.ts#L791-L792', -'_types.aggregations.ChildrenAggregation': '_types/aggregations/bucket.ts#L118-L123', -'_types.aggregations.CompositeAggregate': '_types/aggregations/Aggregate.ts#L623-L628', -'_types.aggregations.CompositeAggregation': '_types/aggregations/bucket.ts#L127-L143', -'_types.aggregations.CompositeAggregationBase': '_types/aggregations/bucket.ts#L164-L173', -'_types.aggregations.CompositeAggregationSource': '_types/aggregations/bucket.ts#L145-L162', -'_types.aggregations.CompositeBucket': '_types/aggregations/Aggregate.ts#L630-L632', -'_types.aggregations.CompositeDateHistogramAggregation': '_types/aggregations/bucket.ts#L181-L189', -'_types.aggregations.CompositeGeoTileGridAggregation': '_types/aggregations/bucket.ts#L191-L194', -'_types.aggregations.CompositeHistogramAggregation': '_types/aggregations/bucket.ts#L177-L179', -'_types.aggregations.CompositeTermsAggregation': '_types/aggregations/bucket.ts#L175-L175', -'_types.aggregations.CumulativeCardinalityAggregate': '_types/aggregations/Aggregate.ts#L762-L770', -'_types.aggregations.CumulativeCardinalityAggregation': '_types/aggregations/pipeline.ts#L192-L192', -'_types.aggregations.CumulativeSumAggregation': '_types/aggregations/pipeline.ts#L194-L194', -'_types.aggregations.CustomCategorizeTextAnalyzer': '_types/aggregations/bucket.ts#L1152-L1156', -'_types.aggregations.DateHistogramAggregate': '_types/aggregations/Aggregate.ts#L351-L352', -'_types.aggregations.DateHistogramAggregation': '_types/aggregations/bucket.ts#L196-L254', -'_types.aggregations.DateHistogramBucket': '_types/aggregations/Aggregate.ts#L354-L357', -'_types.aggregations.DateRangeAggregate': '_types/aggregations/Aggregate.ts#L548-L553', -'_types.aggregations.DateRangeAggregation': '_types/aggregations/bucket.ts#L275-L301', -'_types.aggregations.DateRangeExpression': '_types/aggregations/bucket.ts#L312-L325', -'_types.aggregations.DerivativeAggregate': '_types/aggregations/Aggregate.ts#L228-L232', -'_types.aggregations.DerivativeAggregation': '_types/aggregations/pipeline.ts#L196-L196', -'_types.aggregations.DiversifiedSamplerAggregation': '_types/aggregations/bucket.ts#L327-L348', -'_types.aggregations.DoubleTermsAggregate': '_types/aggregations/Aggregate.ts#L414-L419', -'_types.aggregations.DoubleTermsBucket': '_types/aggregations/Aggregate.ts#L421-L424', -'_types.aggregations.EwmaModelSettings': '_types/aggregations/pipeline.ts#L267-L269', -'_types.aggregations.EwmaMovingAverageAggregation': '_types/aggregations/pipeline.ts#L252-L255', -'_types.aggregations.ExtendedBounds': '_types/aggregations/bucket.ts#L496-L505', -'_types.aggregations.ExtendedStatsAggregate': '_types/aggregations/Aggregate.ts#L279-L297', +'_types.aggregations.CategorizeTextAggregation': '_types/aggregations/bucket.ts#L1117-L1182', +'_types.aggregations.CategorizeTextAnalyzer': '_types/aggregations/bucket.ts#L1184-L1187', +'_types.aggregations.ChiSquareHeuristic': '_types/aggregations/bucket.ts#L782-L791', +'_types.aggregations.ChildrenAggregate': '_types/aggregations/Aggregate.ts#L888-L892', +'_types.aggregations.ChildrenAggregation': '_types/aggregations/bucket.ts#L121-L126', +'_types.aggregations.CompositeAggregate': '_types/aggregations/Aggregate.ts#L698-L703', +'_types.aggregations.CompositeAggregation': '_types/aggregations/bucket.ts#L130-L149', +'_types.aggregations.CompositeAggregationBase': '_types/aggregations/bucket.ts#L170-L179', +'_types.aggregations.CompositeAggregationSource': '_types/aggregations/bucket.ts#L151-L168', +'_types.aggregations.CompositeBucket': '_types/aggregations/Aggregate.ts#L705-L707', +'_types.aggregations.CompositeDateHistogramAggregation': '_types/aggregations/bucket.ts#L187-L195', +'_types.aggregations.CompositeGeoTileGridAggregation': '_types/aggregations/bucket.ts#L197-L200', +'_types.aggregations.CompositeHistogramAggregation': '_types/aggregations/bucket.ts#L183-L185', +'_types.aggregations.CompositeTermsAggregation': '_types/aggregations/bucket.ts#L181-L181', +'_types.aggregations.CumulativeCardinalityAggregate': '_types/aggregations/Aggregate.ts#L856-L864', +'_types.aggregations.CumulativeCardinalityAggregation': '_types/aggregations/pipeline.ts#L206-L209', +'_types.aggregations.CumulativeSumAggregation': '_types/aggregations/pipeline.ts#L211-L214', +'_types.aggregations.CustomCategorizeTextAnalyzer': '_types/aggregations/bucket.ts#L1189-L1193', +'_types.aggregations.DateHistogramAggregate': '_types/aggregations/Aggregate.ts#L383-L386', +'_types.aggregations.DateHistogramAggregation': '_types/aggregations/bucket.ts#L202-L260', +'_types.aggregations.DateHistogramBucket': '_types/aggregations/Aggregate.ts#L388-L391', +'_types.aggregations.DateRangeAggregate': '_types/aggregations/Aggregate.ts#L609-L615', +'_types.aggregations.DateRangeAggregation': '_types/aggregations/bucket.ts#L281-L307', +'_types.aggregations.DateRangeExpression': '_types/aggregations/bucket.ts#L318-L331', +'_types.aggregations.DerivativeAggregate': '_types/aggregations/Aggregate.ts#L241-L248', +'_types.aggregations.DerivativeAggregation': '_types/aggregations/pipeline.ts#L216-L216', +'_types.aggregations.DiversifiedSamplerAggregation': '_types/aggregations/bucket.ts#L333-L357', +'_types.aggregations.DoubleTermsAggregate': '_types/aggregations/Aggregate.ts#L451-L456', +'_types.aggregations.DoubleTermsBucket': '_types/aggregations/Aggregate.ts#L458-L461', +'_types.aggregations.EwmaModelSettings': '_types/aggregations/pipeline.ts#L293-L295', +'_types.aggregations.EwmaMovingAverageAggregation': '_types/aggregations/pipeline.ts#L278-L281', +'_types.aggregations.ExtendedBounds': '_types/aggregations/bucket.ts#L508-L517', +'_types.aggregations.ExtendedStatsAggregate': '_types/aggregations/Aggregate.ts#L299-L320', '_types.aggregations.ExtendedStatsAggregation': '_types/aggregations/metric.ts#L101-L106', -'_types.aggregations.ExtendedStatsBucketAggregate': '_types/aggregations/Aggregate.ts#L299-L300', -'_types.aggregations.ExtendedStatsBucketAggregation': '_types/aggregations/pipeline.ts#L198-L203', -'_types.aggregations.FieldDateMath': '_types/aggregations/bucket.ts#L303-L310', -'_types.aggregations.FilterAggregate': '_types/aggregations/Aggregate.ts#L500-L501', -'_types.aggregations.FiltersAggregate': '_types/aggregations/Aggregate.ts#L573-L574', -'_types.aggregations.FiltersAggregation': '_types/aggregations/bucket.ts#L365-L385', -'_types.aggregations.FiltersBucket': '_types/aggregations/Aggregate.ts#L576-L576', +'_types.aggregations.ExtendedStatsBucketAggregate': '_types/aggregations/Aggregate.ts#L322-L323', +'_types.aggregations.ExtendedStatsBucketAggregation': '_types/aggregations/pipeline.ts#L218-L223', +'_types.aggregations.FieldDateMath': '_types/aggregations/bucket.ts#L309-L316', +'_types.aggregations.FilterAggregate': '_types/aggregations/Aggregate.ts#L552-L556', +'_types.aggregations.FiltersAggregate': '_types/aggregations/Aggregate.ts#L639-L643', +'_types.aggregations.FiltersAggregation': '_types/aggregations/bucket.ts#L374-L394', +'_types.aggregations.FiltersBucket': '_types/aggregations/Aggregate.ts#L645-L645', '_types.aggregations.FormatMetricAggregationBase': '_types/aggregations/metric.ts#L47-L49', '_types.aggregations.FormattableMetricAggregation': '_types/aggregations/metric.ts#L51-L53', -'_types.aggregations.FrequentItemSetsAggregate': '_types/aggregations/Aggregate.ts#L644-L645', -'_types.aggregations.FrequentItemSetsAggregation': '_types/aggregations/bucket.ts#L1203-L1227', -'_types.aggregations.FrequentItemSetsBucket': '_types/aggregations/Aggregate.ts#L647-L650', -'_types.aggregations.FrequentItemSetsField': '_types/aggregations/bucket.ts#L1189-L1201', +'_types.aggregations.FrequentItemSetsAggregate': '_types/aggregations/Aggregate.ts#L722-L723', +'_types.aggregations.FrequentItemSetsAggregation': '_types/aggregations/bucket.ts#L1240-L1267', +'_types.aggregations.FrequentItemSetsBucket': '_types/aggregations/Aggregate.ts#L725-L728', +'_types.aggregations.FrequentItemSetsField': '_types/aggregations/bucket.ts#L1226-L1238', '_types.aggregations.GapPolicy': '_types/aggregations/pipeline.ts#L61-L76', -'_types.aggregations.GeoBoundsAggregate': '_types/aggregations/Aggregate.ts#L304-L307', -'_types.aggregations.GeoBoundsAggregation': '_types/aggregations/metric.ts#L108-L114', -'_types.aggregations.GeoCentroidAggregate': '_types/aggregations/Aggregate.ts#L309-L313', -'_types.aggregations.GeoCentroidAggregation': '_types/aggregations/metric.ts#L116-L119', -'_types.aggregations.GeoDistanceAggregate': '_types/aggregations/Aggregate.ts#L555-L559', -'_types.aggregations.GeoDistanceAggregation': '_types/aggregations/bucket.ts#L387-L410', -'_types.aggregations.GeoHashGridAggregate': '_types/aggregations/Aggregate.ts#L511-L513', -'_types.aggregations.GeoHashGridAggregation': '_types/aggregations/bucket.ts#L412-L437', -'_types.aggregations.GeoHashGridBucket': '_types/aggregations/Aggregate.ts#L515-L517', -'_types.aggregations.GeoHexGridAggregate': '_types/aggregations/Aggregate.ts#L527-L528', -'_types.aggregations.GeoHexGridBucket': '_types/aggregations/Aggregate.ts#L530-L532', -'_types.aggregations.GeoLineAggregate': '_types/aggregations/Aggregate.ts#L799-L806', -'_types.aggregations.GeoLineAggregation': '_types/aggregations/metric.ts#L121-L146', -'_types.aggregations.GeoLinePoint': '_types/aggregations/metric.ts#L155-L160', -'_types.aggregations.GeoLineSort': '_types/aggregations/metric.ts#L148-L153', -'_types.aggregations.GeoTileGridAggregate': '_types/aggregations/Aggregate.ts#L519-L521', -'_types.aggregations.GeoTileGridAggregation': '_types/aggregations/bucket.ts#L439-L465', -'_types.aggregations.GeoTileGridBucket': '_types/aggregations/Aggregate.ts#L523-L525', -'_types.aggregations.GeohexGridAggregation': '_types/aggregations/bucket.ts#L467-L492', -'_types.aggregations.GlobalAggregate': '_types/aggregations/Aggregate.ts#L497-L498', -'_types.aggregations.GlobalAggregation': '_types/aggregations/bucket.ts#L494-L494', -'_types.aggregations.GoogleNormalizedDistanceHeuristic': '_types/aggregations/bucket.ts#L772-L777', -'_types.aggregations.HdrMethod': '_types/aggregations/metric.ts#L216-L221', -'_types.aggregations.HdrPercentileRanksAggregate': '_types/aggregations/Aggregate.ts#L170-L171', -'_types.aggregations.HdrPercentilesAggregate': '_types/aggregations/Aggregate.ts#L167-L168', -'_types.aggregations.HistogramAggregate': '_types/aggregations/Aggregate.ts#L343-L344', -'_types.aggregations.HistogramAggregation': '_types/aggregations/bucket.ts#L507-L553', -'_types.aggregations.HistogramBucket': '_types/aggregations/Aggregate.ts#L346-L349', -'_types.aggregations.HoltLinearModelSettings': '_types/aggregations/pipeline.ts#L271-L274', -'_types.aggregations.HoltMovingAverageAggregation': '_types/aggregations/pipeline.ts#L257-L260', -'_types.aggregations.HoltWintersModelSettings': '_types/aggregations/pipeline.ts#L275-L282', -'_types.aggregations.HoltWintersMovingAverageAggregation': '_types/aggregations/pipeline.ts#L262-L265', -'_types.aggregations.HoltWintersType': '_types/aggregations/pipeline.ts#L283-L286', -'_types.aggregations.InferenceAggregate': '_types/aggregations/Aggregate.ts#L671-L685', -'_types.aggregations.InferenceAggregation': '_types/aggregations/pipeline.ts#L205-L214', -'_types.aggregations.InferenceClassImportance': '_types/aggregations/Aggregate.ts#L699-L702', -'_types.aggregations.InferenceConfigContainer': '_types/aggregations/pipeline.ts#L216-L222', -'_types.aggregations.InferenceFeatureImportance': '_types/aggregations/Aggregate.ts#L693-L697', -'_types.aggregations.InferenceTopClassEntry': '_types/aggregations/Aggregate.ts#L687-L691', -'_types.aggregations.IpPrefixAggregate': '_types/aggregations/Aggregate.ts#L634-L635', -'_types.aggregations.IpPrefixAggregation': '_types/aggregations/bucket.ts#L1158-L1187', -'_types.aggregations.IpPrefixBucket': '_types/aggregations/Aggregate.ts#L637-L642', -'_types.aggregations.IpRangeAggregate': '_types/aggregations/Aggregate.ts#L561-L563', -'_types.aggregations.IpRangeAggregation': '_types/aggregations/bucket.ts#L555-L564', -'_types.aggregations.IpRangeAggregationRange': '_types/aggregations/bucket.ts#L566-L579', -'_types.aggregations.IpRangeBucket': '_types/aggregations/Aggregate.ts#L565-L569', -'_types.aggregations.LinearMovingAverageAggregation': '_types/aggregations/pipeline.ts#L242-L245', -'_types.aggregations.LongRareTermsAggregate': '_types/aggregations/Aggregate.ts#L434-L439', -'_types.aggregations.LongRareTermsBucket': '_types/aggregations/Aggregate.ts#L441-L444', -'_types.aggregations.LongTermsAggregate': '_types/aggregations/Aggregate.ts#L402-L407', -'_types.aggregations.LongTermsBucket': '_types/aggregations/Aggregate.ts#L409-L412', +'_types.aggregations.GeoBoundsAggregate': '_types/aggregations/Aggregate.ts#L327-L333', +'_types.aggregations.GeoBoundsAggregation': '_types/aggregations/metric.ts#L108-L117', +'_types.aggregations.GeoCentroidAggregate': '_types/aggregations/Aggregate.ts#L335-L342', +'_types.aggregations.GeoCentroidAggregation': '_types/aggregations/metric.ts#L119-L122', +'_types.aggregations.GeoDistanceAggregate': '_types/aggregations/Aggregate.ts#L617-L622', +'_types.aggregations.GeoDistanceAggregation': '_types/aggregations/bucket.ts#L396-L419', +'_types.aggregations.GeoHashGridAggregate': '_types/aggregations/Aggregate.ts#L566-L568', +'_types.aggregations.GeoHashGridAggregation': '_types/aggregations/bucket.ts#L421-L449', +'_types.aggregations.GeoHashGridBucket': '_types/aggregations/Aggregate.ts#L570-L572', +'_types.aggregations.GeoHexGridAggregate': '_types/aggregations/Aggregate.ts#L585-L586', +'_types.aggregations.GeoHexGridBucket': '_types/aggregations/Aggregate.ts#L588-L590', +'_types.aggregations.GeoLineAggregate': '_types/aggregations/Aggregate.ts#L902-L912', +'_types.aggregations.GeoLineAggregation': '_types/aggregations/metric.ts#L124-L149', +'_types.aggregations.GeoLinePoint': '_types/aggregations/metric.ts#L158-L163', +'_types.aggregations.GeoLineSort': '_types/aggregations/metric.ts#L151-L156', +'_types.aggregations.GeoTileGridAggregate': '_types/aggregations/Aggregate.ts#L574-L579', +'_types.aggregations.GeoTileGridAggregation': '_types/aggregations/bucket.ts#L451-L477', +'_types.aggregations.GeoTileGridBucket': '_types/aggregations/Aggregate.ts#L581-L583', +'_types.aggregations.GeohexGridAggregation': '_types/aggregations/bucket.ts#L479-L504', +'_types.aggregations.GlobalAggregate': '_types/aggregations/Aggregate.ts#L546-L550', +'_types.aggregations.GlobalAggregation': '_types/aggregations/bucket.ts#L506-L506', +'_types.aggregations.GoogleNormalizedDistanceHeuristic': '_types/aggregations/bucket.ts#L793-L798', +'_types.aggregations.HdrMethod': '_types/aggregations/metric.ts#L225-L230', +'_types.aggregations.HdrPercentileRanksAggregate': '_types/aggregations/Aggregate.ts#L171-L172', +'_types.aggregations.HdrPercentilesAggregate': '_types/aggregations/Aggregate.ts#L168-L169', +'_types.aggregations.HistogramAggregate': '_types/aggregations/Aggregate.ts#L372-L376', +'_types.aggregations.HistogramAggregation': '_types/aggregations/bucket.ts#L519-L565', +'_types.aggregations.HistogramBucket': '_types/aggregations/Aggregate.ts#L378-L381', +'_types.aggregations.HoltLinearModelSettings': '_types/aggregations/pipeline.ts#L297-L300', +'_types.aggregations.HoltMovingAverageAggregation': '_types/aggregations/pipeline.ts#L283-L286', +'_types.aggregations.HoltWintersModelSettings': '_types/aggregations/pipeline.ts#L301-L308', +'_types.aggregations.HoltWintersMovingAverageAggregation': '_types/aggregations/pipeline.ts#L288-L291', +'_types.aggregations.HoltWintersType': '_types/aggregations/pipeline.ts#L309-L312', +'_types.aggregations.InferenceAggregate': '_types/aggregations/Aggregate.ts#L755-L770', +'_types.aggregations.InferenceAggregation': '_types/aggregations/pipeline.ts#L225-L234', +'_types.aggregations.InferenceClassImportance': '_types/aggregations/Aggregate.ts#L784-L787', +'_types.aggregations.InferenceConfigContainer': '_types/aggregations/pipeline.ts#L236-L242', +'_types.aggregations.InferenceFeatureImportance': '_types/aggregations/Aggregate.ts#L778-L782', +'_types.aggregations.InferenceTopClassEntry': '_types/aggregations/Aggregate.ts#L772-L776', +'_types.aggregations.IpPrefixAggregate': '_types/aggregations/Aggregate.ts#L709-L713', +'_types.aggregations.IpPrefixAggregation': '_types/aggregations/bucket.ts#L1195-L1224', +'_types.aggregations.IpPrefixBucket': '_types/aggregations/Aggregate.ts#L715-L720', +'_types.aggregations.IpRangeAggregate': '_types/aggregations/Aggregate.ts#L624-L629', +'_types.aggregations.IpRangeAggregation': '_types/aggregations/bucket.ts#L567-L576', +'_types.aggregations.IpRangeAggregationRange': '_types/aggregations/bucket.ts#L578-L591', +'_types.aggregations.IpRangeBucket': '_types/aggregations/Aggregate.ts#L631-L635', +'_types.aggregations.LinearMovingAverageAggregation': '_types/aggregations/pipeline.ts#L268-L271', +'_types.aggregations.LongRareTermsAggregate': '_types/aggregations/Aggregate.ts#L471-L476', +'_types.aggregations.LongRareTermsBucket': '_types/aggregations/Aggregate.ts#L478-L481', +'_types.aggregations.LongTermsAggregate': '_types/aggregations/Aggregate.ts#L439-L444', +'_types.aggregations.LongTermsBucket': '_types/aggregations/Aggregate.ts#L446-L449', '_types.aggregations.MatrixAggregation': '_types/aggregations/matrix.ts#L26-L36', -'_types.aggregations.MatrixStatsAggregate': '_types/aggregations/Aggregate.ts#L772-L776', +'_types.aggregations.MatrixStatsAggregate': '_types/aggregations/Aggregate.ts#L866-L873', '_types.aggregations.MatrixStatsAggregation': '_types/aggregations/matrix.ts#L38-L44', -'_types.aggregations.MatrixStatsFields': '_types/aggregations/Aggregate.ts#L778-L787', -'_types.aggregations.MaxAggregate': '_types/aggregations/Aggregate.ts#L201-L202', -'_types.aggregations.MaxAggregation': '_types/aggregations/metric.ts#L162-L162', -'_types.aggregations.MaxBucketAggregation': '_types/aggregations/pipeline.ts#L224-L224', -'_types.aggregations.MedianAbsoluteDeviationAggregate': '_types/aggregations/Aggregate.ts#L195-L196', -'_types.aggregations.MedianAbsoluteDeviationAggregation': '_types/aggregations/metric.ts#L164-L170', +'_types.aggregations.MatrixStatsFields': '_types/aggregations/Aggregate.ts#L875-L884', +'_types.aggregations.MaxAggregate': '_types/aggregations/Aggregate.ts#L205-L209', +'_types.aggregations.MaxAggregation': '_types/aggregations/metric.ts#L165-L165', +'_types.aggregations.MaxBucketAggregation': '_types/aggregations/pipeline.ts#L244-L247', +'_types.aggregations.MedianAbsoluteDeviationAggregate': '_types/aggregations/Aggregate.ts#L196-L197', +'_types.aggregations.MedianAbsoluteDeviationAggregation': '_types/aggregations/metric.ts#L167-L176', '_types.aggregations.MetricAggregationBase': '_types/aggregations/metric.ts#L34-L45', -'_types.aggregations.MinAggregate': '_types/aggregations/Aggregate.ts#L198-L199', -'_types.aggregations.MinAggregation': '_types/aggregations/metric.ts#L172-L172', -'_types.aggregations.MinBucketAggregation': '_types/aggregations/pipeline.ts#L226-L226', -'_types.aggregations.MinimumInterval': '_types/aggregations/bucket.ts#L109-L116', -'_types.aggregations.MissingAggregate': '_types/aggregations/Aggregate.ts#L488-L489', -'_types.aggregations.MissingAggregation': '_types/aggregations/bucket.ts#L581-L587', +'_types.aggregations.MinAggregate': '_types/aggregations/Aggregate.ts#L199-L203', +'_types.aggregations.MinAggregation': '_types/aggregations/metric.ts#L178-L178', +'_types.aggregations.MinBucketAggregation': '_types/aggregations/pipeline.ts#L249-L252', +'_types.aggregations.MinimumInterval': '_types/aggregations/bucket.ts#L112-L119', +'_types.aggregations.MissingAggregate': '_types/aggregations/Aggregate.ts#L528-L532', +'_types.aggregations.MissingAggregation': '_types/aggregations/bucket.ts#L593-L599', '_types.aggregations.MissingOrder': '_types/aggregations/AggregationContainer.ts#L536-L540', -'_types.aggregations.MovingAverageAggregation': '_types/aggregations/pipeline.ts#L228-L234', -'_types.aggregations.MovingAverageAggregationBase': '_types/aggregations/pipeline.ts#L236-L240', -'_types.aggregations.MovingFunctionAggregation': '_types/aggregations/pipeline.ts#L288-L303', -'_types.aggregations.MovingPercentilesAggregation': '_types/aggregations/pipeline.ts#L305-L317', -'_types.aggregations.MultiBucketAggregateBase': '_types/aggregations/Aggregate.ts#L328-L330', -'_types.aggregations.MultiBucketBase': '_types/aggregations/Aggregate.ts#L332-L341', -'_types.aggregations.MultiTermLookup': '_types/aggregations/bucket.ts#L631-L641', -'_types.aggregations.MultiTermsAggregate': '_types/aggregations/Aggregate.ts#L464-L466', -'_types.aggregations.MultiTermsAggregation': '_types/aggregations/bucket.ts#L589-L629', -'_types.aggregations.MultiTermsBucket': '_types/aggregations/Aggregate.ts#L468-L472', -'_types.aggregations.MutualInformationHeuristic': '_types/aggregations/bucket.ts#L779-L788', -'_types.aggregations.NestedAggregate': '_types/aggregations/Aggregate.ts#L491-L492', -'_types.aggregations.NestedAggregation': '_types/aggregations/bucket.ts#L643-L648', -'_types.aggregations.NormalizeAggregation': '_types/aggregations/pipeline.ts#L319-L324', -'_types.aggregations.NormalizeMethod': '_types/aggregations/pipeline.ts#L326-L352', -'_types.aggregations.ParentAggregate': '_types/aggregations/Aggregate.ts#L794-L795', -'_types.aggregations.ParentAggregation': '_types/aggregations/bucket.ts#L650-L655', -'_types.aggregations.PercentageScoreHeuristic': '_types/aggregations/bucket.ts#L790-L790', -'_types.aggregations.PercentileRanksAggregation': '_types/aggregations/metric.ts#L174-L193', -'_types.aggregations.Percentiles': '_types/aggregations/Aggregate.ts#L151-L152', -'_types.aggregations.PercentilesAggregateBase': '_types/aggregations/Aggregate.ts#L147-L149', -'_types.aggregations.PercentilesAggregation': '_types/aggregations/metric.ts#L195-L214', -'_types.aggregations.PercentilesBucketAggregate': '_types/aggregations/Aggregate.ts#L179-L180', -'_types.aggregations.PercentilesBucketAggregation': '_types/aggregations/pipeline.ts#L354-L359', +'_types.aggregations.MovingAverageAggregation': '_types/aggregations/pipeline.ts#L254-L260', +'_types.aggregations.MovingAverageAggregationBase': '_types/aggregations/pipeline.ts#L262-L266', +'_types.aggregations.MovingFunctionAggregation': '_types/aggregations/pipeline.ts#L314-L332', +'_types.aggregations.MovingPercentilesAggregation': '_types/aggregations/pipeline.ts#L334-L349', +'_types.aggregations.MultiBucketAggregateBase': '_types/aggregations/Aggregate.ts#L357-L359', +'_types.aggregations.MultiBucketBase': '_types/aggregations/Aggregate.ts#L361-L370', +'_types.aggregations.MultiTermLookup': '_types/aggregations/bucket.ts#L643-L653', +'_types.aggregations.MultiTermsAggregate': '_types/aggregations/Aggregate.ts#L501-L506', +'_types.aggregations.MultiTermsAggregation': '_types/aggregations/bucket.ts#L601-L641', +'_types.aggregations.MultiTermsBucket': '_types/aggregations/Aggregate.ts#L508-L512', +'_types.aggregations.MutualInformationHeuristic': '_types/aggregations/bucket.ts#L800-L809', +'_types.aggregations.NestedAggregate': '_types/aggregations/Aggregate.ts#L534-L538', +'_types.aggregations.NestedAggregation': '_types/aggregations/bucket.ts#L655-L660', +'_types.aggregations.NormalizeAggregation': '_types/aggregations/pipeline.ts#L351-L359', +'_types.aggregations.NormalizeMethod': '_types/aggregations/pipeline.ts#L361-L387', +'_types.aggregations.ParentAggregate': '_types/aggregations/Aggregate.ts#L894-L898', +'_types.aggregations.ParentAggregation': '_types/aggregations/bucket.ts#L662-L667', +'_types.aggregations.PercentageScoreHeuristic': '_types/aggregations/bucket.ts#L811-L811', +'_types.aggregations.PercentileRanksAggregation': '_types/aggregations/metric.ts#L180-L202', +'_types.aggregations.Percentiles': '_types/aggregations/Aggregate.ts#L152-L153', +'_types.aggregations.PercentilesAggregateBase': '_types/aggregations/Aggregate.ts#L148-L150', +'_types.aggregations.PercentilesAggregation': '_types/aggregations/metric.ts#L204-L223', +'_types.aggregations.PercentilesBucketAggregate': '_types/aggregations/Aggregate.ts#L180-L181', +'_types.aggregations.PercentilesBucketAggregation': '_types/aggregations/pipeline.ts#L389-L397', '_types.aggregations.PipelineAggregationBase': '_types/aggregations/pipeline.ts#L39-L51', -'_types.aggregations.RandomSamplerAggregation': '_types/aggregations/bucket.ts#L734-L751', -'_types.aggregations.RangeAggregate': '_types/aggregations/Aggregate.ts#L536-L537', -'_types.aggregations.RangeAggregation': '_types/aggregations/bucket.ts#L657-L677', -'_types.aggregations.RangeBucket': '_types/aggregations/Aggregate.ts#L539-L546', -'_types.aggregations.RareTermsAggregation': '_types/aggregations/bucket.ts#L694-L724', -'_types.aggregations.RateAggregate': '_types/aggregations/Aggregate.ts#L756-L760', -'_types.aggregations.RateAggregation': '_types/aggregations/metric.ts#L230-L241', -'_types.aggregations.RateMode': '_types/aggregations/metric.ts#L243-L252', -'_types.aggregations.ReverseNestedAggregate': '_types/aggregations/Aggregate.ts#L494-L495', -'_types.aggregations.ReverseNestedAggregation': '_types/aggregations/bucket.ts#L726-L732', -'_types.aggregations.SamplerAggregate': '_types/aggregations/Aggregate.ts#L503-L504', -'_types.aggregations.SamplerAggregation': '_types/aggregations/bucket.ts#L753-L759', -'_types.aggregations.SamplerAggregationExecutionHint': '_types/aggregations/bucket.ts#L350-L363', -'_types.aggregations.ScriptedHeuristic': '_types/aggregations/bucket.ts#L792-L794', -'_types.aggregations.ScriptedMetricAggregate': '_types/aggregations/Aggregate.ts#L661-L664', -'_types.aggregations.ScriptedMetricAggregation': '_types/aggregations/metric.ts#L254-L280', -'_types.aggregations.SerialDifferencingAggregation': '_types/aggregations/pipeline.ts#L361-L367', -'_types.aggregations.SignificantLongTermsAggregate': '_types/aggregations/Aggregate.ts#L593-L595', -'_types.aggregations.SignificantLongTermsBucket': '_types/aggregations/Aggregate.ts#L602-L605', -'_types.aggregations.SignificantStringTermsAggregate': '_types/aggregations/Aggregate.ts#L607-L609', -'_types.aggregations.SignificantStringTermsBucket': '_types/aggregations/Aggregate.ts#L611-L613', -'_types.aggregations.SignificantTermsAggregateBase': '_types/aggregations/Aggregate.ts#L586-L591', -'_types.aggregations.SignificantTermsAggregation': '_types/aggregations/bucket.ts#L796-L860', -'_types.aggregations.SignificantTermsBucketBase': '_types/aggregations/Aggregate.ts#L597-L600', -'_types.aggregations.SignificantTextAggregation': '_types/aggregations/bucket.ts#L862-L934', -'_types.aggregations.SimpleMovingAverageAggregation': '_types/aggregations/pipeline.ts#L247-L250', -'_types.aggregations.SimpleValueAggregate': '_types/aggregations/Aggregate.ts#L225-L226', -'_types.aggregations.SingleBucketAggregateBase': '_types/aggregations/Aggregate.ts#L476-L486', -'_types.aggregations.SingleMetricAggregateBase': '_types/aggregations/Aggregate.ts#L184-L193', -'_types.aggregations.StandardDeviationBounds': '_types/aggregations/Aggregate.ts#L261-L268', -'_types.aggregations.StandardDeviationBoundsAsString': '_types/aggregations/Aggregate.ts#L270-L277', -'_types.aggregations.StatsAggregate': '_types/aggregations/Aggregate.ts#L241-L256', -'_types.aggregations.StatsAggregation': '_types/aggregations/metric.ts#L282-L282', -'_types.aggregations.StatsBucketAggregate': '_types/aggregations/Aggregate.ts#L258-L259', -'_types.aggregations.StatsBucketAggregation': '_types/aggregations/pipeline.ts#L369-L369', -'_types.aggregations.StringRareTermsAggregate': '_types/aggregations/Aggregate.ts#L446-L450', -'_types.aggregations.StringRareTermsBucket': '_types/aggregations/Aggregate.ts#L452-L454', -'_types.aggregations.StringStatsAggregate': '_types/aggregations/Aggregate.ts#L708-L719', -'_types.aggregations.StringStatsAggregation': '_types/aggregations/metric.ts#L284-L290', -'_types.aggregations.StringTermsAggregate': '_types/aggregations/Aggregate.ts#L387-L392', -'_types.aggregations.StringTermsBucket': '_types/aggregations/Aggregate.ts#L398-L400', -'_types.aggregations.SumAggregate': '_types/aggregations/Aggregate.ts#L204-L208', -'_types.aggregations.SumAggregation': '_types/aggregations/metric.ts#L292-L292', -'_types.aggregations.SumBucketAggregation': '_types/aggregations/pipeline.ts#L371-L371', -'_types.aggregations.TDigest': '_types/aggregations/metric.ts#L223-L228', -'_types.aggregations.TDigestPercentileRanksAggregate': '_types/aggregations/Aggregate.ts#L176-L177', -'_types.aggregations.TDigestPercentilesAggregate': '_types/aggregations/Aggregate.ts#L173-L174', -'_types.aggregations.TTestAggregate': '_types/aggregations/Aggregate.ts#L750-L754', -'_types.aggregations.TTestAggregation': '_types/aggregations/metric.ts#L294-L308', -'_types.aggregations.TTestType': '_types/aggregations/metric.ts#L322-L335', -'_types.aggregations.TermsAggregateBase': '_types/aggregations/Aggregate.ts#L380-L385', -'_types.aggregations.TermsAggregation': '_types/aggregations/bucket.ts#L936-L1001', -'_types.aggregations.TermsAggregationCollectMode': '_types/aggregations/bucket.ts#L1023-L1032', -'_types.aggregations.TermsAggregationExecutionHint': '_types/aggregations/bucket.ts#L1034-L1039', -'_types.aggregations.TermsBucketBase': '_types/aggregations/Aggregate.ts#L394-L396', -'_types.aggregations.TermsExclude': '_types/aggregations/bucket.ts#L1044-L1045', -'_types.aggregations.TermsInclude': '_types/aggregations/bucket.ts#L1041-L1042', -'_types.aggregations.TermsPartition': '_types/aggregations/bucket.ts#L1047-L1056', -'_types.aggregations.TestPopulation': '_types/aggregations/metric.ts#L310-L320', -'_types.aggregations.TimeSeriesAggregate': '_types/aggregations/Aggregate.ts#L652-L653', -'_types.aggregations.TimeSeriesAggregation': '_types/aggregations/bucket.ts#L1003-L1013', -'_types.aggregations.TimeSeriesBucket': '_types/aggregations/Aggregate.ts#L655-L657', -'_types.aggregations.TopHitsAggregate': '_types/aggregations/Aggregate.ts#L666-L669', -'_types.aggregations.TopHitsAggregation': '_types/aggregations/metric.ts#L337-L397', -'_types.aggregations.TopMetrics': '_types/aggregations/Aggregate.ts#L744-L748', -'_types.aggregations.TopMetricsAggregate': '_types/aggregations/Aggregate.ts#L739-L742', -'_types.aggregations.TopMetricsAggregation': '_types/aggregations/metric.ts#L399-L413', -'_types.aggregations.TopMetricsValue': '_types/aggregations/metric.ts#L415-L420', -'_types.aggregations.UnmappedRareTermsAggregate': '_types/aggregations/Aggregate.ts#L456-L462', -'_types.aggregations.UnmappedSamplerAggregate': '_types/aggregations/Aggregate.ts#L506-L507', -'_types.aggregations.UnmappedSignificantTermsAggregate': '_types/aggregations/Aggregate.ts#L615-L621', -'_types.aggregations.UnmappedTermsAggregate': '_types/aggregations/Aggregate.ts#L426-L432', -'_types.aggregations.ValueCountAggregate': '_types/aggregations/Aggregate.ts#L219-L223', -'_types.aggregations.ValueCountAggregation': '_types/aggregations/metric.ts#L422-L422', -'_types.aggregations.ValueType': '_types/aggregations/metric.ts#L424-L435', -'_types.aggregations.VariableWidthHistogramAggregate': '_types/aggregations/Aggregate.ts#L365-L367', -'_types.aggregations.VariableWidthHistogramAggregation': '_types/aggregations/bucket.ts#L1058-L1079', -'_types.aggregations.VariableWidthHistogramBucket': '_types/aggregations/Aggregate.ts#L369-L376', -'_types.aggregations.WeightedAverageAggregation': '_types/aggregations/metric.ts#L437-L451', -'_types.aggregations.WeightedAverageValue': '_types/aggregations/metric.ts#L453-L463', -'_types.aggregations.WeightedAvgAggregate': '_types/aggregations/Aggregate.ts#L213-L217', +'_types.aggregations.RandomSamplerAggregation': '_types/aggregations/bucket.ts#L749-L769', +'_types.aggregations.RangeAggregate': '_types/aggregations/Aggregate.ts#L594-L598', +'_types.aggregations.RangeAggregation': '_types/aggregations/bucket.ts#L669-L689', +'_types.aggregations.RangeBucket': '_types/aggregations/Aggregate.ts#L600-L607', +'_types.aggregations.RareTermsAggregation': '_types/aggregations/bucket.ts#L706-L739', +'_types.aggregations.RateAggregate': '_types/aggregations/Aggregate.ts#L847-L854', +'_types.aggregations.RateAggregation': '_types/aggregations/metric.ts#L239-L250', +'_types.aggregations.RateMode': '_types/aggregations/metric.ts#L252-L261', +'_types.aggregations.ReverseNestedAggregate': '_types/aggregations/Aggregate.ts#L540-L544', +'_types.aggregations.ReverseNestedAggregation': '_types/aggregations/bucket.ts#L741-L747', +'_types.aggregations.SamplerAggregate': '_types/aggregations/Aggregate.ts#L558-L559', +'_types.aggregations.SamplerAggregation': '_types/aggregations/bucket.ts#L771-L780', +'_types.aggregations.SamplerAggregationExecutionHint': '_types/aggregations/bucket.ts#L359-L372', +'_types.aggregations.ScriptedHeuristic': '_types/aggregations/bucket.ts#L813-L815', +'_types.aggregations.ScriptedMetricAggregate': '_types/aggregations/Aggregate.ts#L739-L745', +'_types.aggregations.ScriptedMetricAggregation': '_types/aggregations/metric.ts#L263-L289', +'_types.aggregations.SerialDifferencingAggregation': '_types/aggregations/pipeline.ts#L399-L408', +'_types.aggregations.SignificantLongTermsAggregate': '_types/aggregations/Aggregate.ts#L668-L670', +'_types.aggregations.SignificantLongTermsBucket': '_types/aggregations/Aggregate.ts#L677-L680', +'_types.aggregations.SignificantStringTermsAggregate': '_types/aggregations/Aggregate.ts#L682-L684', +'_types.aggregations.SignificantStringTermsBucket': '_types/aggregations/Aggregate.ts#L686-L688', +'_types.aggregations.SignificantTermsAggregateBase': '_types/aggregations/Aggregate.ts#L658-L666', +'_types.aggregations.SignificantTermsAggregation': '_types/aggregations/bucket.ts#L817-L884', +'_types.aggregations.SignificantTermsBucketBase': '_types/aggregations/Aggregate.ts#L672-L675', +'_types.aggregations.SignificantTextAggregation': '_types/aggregations/bucket.ts#L886-L961', +'_types.aggregations.SimpleMovingAverageAggregation': '_types/aggregations/pipeline.ts#L273-L276', +'_types.aggregations.SimpleValueAggregate': '_types/aggregations/Aggregate.ts#L238-L239', +'_types.aggregations.SingleBucketAggregateBase': '_types/aggregations/Aggregate.ts#L516-L526', +'_types.aggregations.SingleMetricAggregateBase': '_types/aggregations/Aggregate.ts#L185-L194', +'_types.aggregations.StandardDeviationBounds': '_types/aggregations/Aggregate.ts#L281-L288', +'_types.aggregations.StandardDeviationBoundsAsString': '_types/aggregations/Aggregate.ts#L290-L297', +'_types.aggregations.StatsAggregate': '_types/aggregations/Aggregate.ts#L257-L273', +'_types.aggregations.StatsAggregation': '_types/aggregations/metric.ts#L291-L291', +'_types.aggregations.StatsBucketAggregate': '_types/aggregations/Aggregate.ts#L275-L279', +'_types.aggregations.StatsBucketAggregation': '_types/aggregations/pipeline.ts#L410-L410', +'_types.aggregations.StringRareTermsAggregate': '_types/aggregations/Aggregate.ts#L483-L487', +'_types.aggregations.StringRareTermsBucket': '_types/aggregations/Aggregate.ts#L489-L491', +'_types.aggregations.StringStatsAggregate': '_types/aggregations/Aggregate.ts#L793-L804', +'_types.aggregations.StringStatsAggregation': '_types/aggregations/metric.ts#L293-L299', +'_types.aggregations.StringTermsAggregate': '_types/aggregations/Aggregate.ts#L424-L429', +'_types.aggregations.StringTermsBucket': '_types/aggregations/Aggregate.ts#L435-L437', +'_types.aggregations.SumAggregate': '_types/aggregations/Aggregate.ts#L211-L216', +'_types.aggregations.SumAggregation': '_types/aggregations/metric.ts#L301-L301', +'_types.aggregations.SumBucketAggregation': '_types/aggregations/pipeline.ts#L412-L415', +'_types.aggregations.TDigest': '_types/aggregations/metric.ts#L232-L237', +'_types.aggregations.TDigestPercentileRanksAggregate': '_types/aggregations/Aggregate.ts#L177-L178', +'_types.aggregations.TDigestPercentilesAggregate': '_types/aggregations/Aggregate.ts#L174-L175', +'_types.aggregations.TTestAggregate': '_types/aggregations/Aggregate.ts#L838-L845', +'_types.aggregations.TTestAggregation': '_types/aggregations/metric.ts#L303-L317', +'_types.aggregations.TTestType': '_types/aggregations/metric.ts#L331-L344', +'_types.aggregations.TermsAggregateBase': '_types/aggregations/Aggregate.ts#L417-L422', +'_types.aggregations.TermsAggregation': '_types/aggregations/bucket.ts#L963-L1031', +'_types.aggregations.TermsAggregationCollectMode': '_types/aggregations/bucket.ts#L1056-L1065', +'_types.aggregations.TermsAggregationExecutionHint': '_types/aggregations/bucket.ts#L1067-L1072', +'_types.aggregations.TermsBucketBase': '_types/aggregations/Aggregate.ts#L431-L433', +'_types.aggregations.TermsExclude': '_types/aggregations/bucket.ts#L1077-L1078', +'_types.aggregations.TermsInclude': '_types/aggregations/bucket.ts#L1074-L1075', +'_types.aggregations.TermsPartition': '_types/aggregations/bucket.ts#L1080-L1089', +'_types.aggregations.TestPopulation': '_types/aggregations/metric.ts#L319-L329', +'_types.aggregations.TimeSeriesAggregate': '_types/aggregations/Aggregate.ts#L730-L731', +'_types.aggregations.TimeSeriesAggregation': '_types/aggregations/bucket.ts#L1033-L1046', +'_types.aggregations.TimeSeriesBucket': '_types/aggregations/Aggregate.ts#L733-L735', +'_types.aggregations.TopHitsAggregate': '_types/aggregations/Aggregate.ts#L747-L753', +'_types.aggregations.TopHitsAggregation': '_types/aggregations/metric.ts#L346-L406', +'_types.aggregations.TopMetrics': '_types/aggregations/Aggregate.ts#L832-L836', +'_types.aggregations.TopMetricsAggregate': '_types/aggregations/Aggregate.ts#L827-L830', +'_types.aggregations.TopMetricsAggregation': '_types/aggregations/metric.ts#L408-L425', +'_types.aggregations.TopMetricsValue': '_types/aggregations/metric.ts#L427-L432', +'_types.aggregations.UnmappedRareTermsAggregate': '_types/aggregations/Aggregate.ts#L493-L499', +'_types.aggregations.UnmappedSamplerAggregate': '_types/aggregations/Aggregate.ts#L561-L562', +'_types.aggregations.UnmappedSignificantTermsAggregate': '_types/aggregations/Aggregate.ts#L690-L696', +'_types.aggregations.UnmappedTermsAggregate': '_types/aggregations/Aggregate.ts#L463-L469', +'_types.aggregations.ValueCountAggregate': '_types/aggregations/Aggregate.ts#L231-L236', +'_types.aggregations.ValueCountAggregation': '_types/aggregations/metric.ts#L434-L434', +'_types.aggregations.ValueType': '_types/aggregations/metric.ts#L436-L447', +'_types.aggregations.VariableWidthHistogramAggregate': '_types/aggregations/Aggregate.ts#L402-L404', +'_types.aggregations.VariableWidthHistogramAggregation': '_types/aggregations/bucket.ts#L1091-L1115', +'_types.aggregations.VariableWidthHistogramBucket': '_types/aggregations/Aggregate.ts#L406-L413', +'_types.aggregations.WeightedAverageAggregation': '_types/aggregations/metric.ts#L449-L463', +'_types.aggregations.WeightedAverageValue': '_types/aggregations/metric.ts#L465-L475', +'_types.aggregations.WeightedAvgAggregate': '_types/aggregations/Aggregate.ts#L224-L229', '_types.analysis.Analyzer': '_types/analysis/analyzers.ts#L359-L413', '_types.analysis.ArabicAnalyzer': '_types/analysis/analyzers.ts#L61-L66', '_types.analysis.ArmenianAnalyzer': '_types/analysis/analyzers.ts#L68-L73', @@ -635,9 +635,9 @@ '_types.analysis.BrazilianAnalyzer': '_types/analysis/analyzers.ts#L89-L93', '_types.analysis.BulgarianAnalyzer': '_types/analysis/analyzers.ts#L95-L100', '_types.analysis.CatalanAnalyzer': '_types/analysis/analyzers.ts#L102-L107', -'_types.analysis.CharFilter': '_types/analysis/char_filters.ts#L28-L30', +'_types.analysis.CharFilter': '_types/analysis/char_filters.ts#L28-L33', '_types.analysis.CharFilterBase': '_types/analysis/char_filters.ts#L24-L26', -'_types.analysis.CharFilterDefinition': '_types/analysis/char_filters.ts#L32-L41', +'_types.analysis.CharFilterDefinition': '_types/analysis/char_filters.ts#L35-L44', '_types.analysis.CharGroupTokenizer': '_types/analysis/tokenizers.ts#L31-L38', '_types.analysis.ChineseAnalyzer': '_types/analysis/analyzers.ts#L109-L113', '_types.analysis.CjkAnalyzer': '_types/analysis/analyzers.ts#L115-L119', @@ -667,7 +667,7 @@ '_types.analysis.GermanAnalyzer': '_types/analysis/analyzers.ts#L175-L180', '_types.analysis.GreekAnalyzer': '_types/analysis/analyzers.ts#L182-L186', '_types.analysis.HindiAnalyzer': '_types/analysis/analyzers.ts#L188-L193', -'_types.analysis.HtmlStripCharFilter': '_types/analysis/char_filters.ts#L43-L46', +'_types.analysis.HtmlStripCharFilter': '_types/analysis/char_filters.ts#L46-L49', '_types.analysis.HungarianAnalyzer': '_types/analysis/analyzers.ts#L195-L200', '_types.analysis.HunspellTokenFilter': '_types/analysis/token_filters.ts#L201-L207', '_types.analysis.HyphenationDecompounderTokenFilter': '_types/analysis/token_filters.ts#L57-L59', @@ -712,7 +712,7 @@ '_types.analysis.LowercaseNormalizer': '_types/analysis/normalizers.ts#L26-L28', '_types.analysis.LowercaseTokenFilter': '_types/analysis/token_filters.ts#L256-L259', '_types.analysis.LowercaseTokenizer': '_types/analysis/tokenizers.ts#L80-L82', -'_types.analysis.MappingCharFilter': '_types/analysis/char_filters.ts#L48-L52', +'_types.analysis.MappingCharFilter': '_types/analysis/char_filters.ts#L51-L55', '_types.analysis.MultiplexerTokenFilter': '_types/analysis/token_filters.ts#L261-L265', '_types.analysis.NGramTokenFilter': '_types/analysis/token_filters.ts#L267-L272', '_types.analysis.NGramTokenizer': '_types/analysis/tokenizers.ts#L84-L93', @@ -725,7 +725,7 @@ '_types.analysis.PathHierarchyTokenizer': '_types/analysis/tokenizers.ts#L95-L102', '_types.analysis.PatternAnalyzer': '_types/analysis/analyzers.ts#L320-L327', '_types.analysis.PatternCaptureTokenFilter': '_types/analysis/token_filters.ts#L279-L283', -'_types.analysis.PatternReplaceCharFilter': '_types/analysis/char_filters.ts#L54-L59', +'_types.analysis.PatternReplaceCharFilter': '_types/analysis/char_filters.ts#L57-L62', '_types.analysis.PatternReplaceTokenFilter': '_types/analysis/token_filters.ts#L285-L291', '_types.analysis.PatternTokenizer': '_types/analysis/tokenizers.ts#L104-L109', '_types.analysis.PersianAnalyzer': '_types/analysis/analyzers.ts#L244-L248', @@ -764,12 +764,12 @@ '_types.analysis.ThaiAnalyzer': '_types/analysis/analyzers.ts#L306-L310', '_types.analysis.ThaiTokenizer': '_types/analysis/tokenizers.ts#L126-L128', '_types.analysis.TokenChar': '_types/analysis/tokenizers.ts#L59-L66', -'_types.analysis.TokenFilter': '_types/analysis/token_filters.ts#L345-L347', +'_types.analysis.TokenFilter': '_types/analysis/token_filters.ts#L345-L350', '_types.analysis.TokenFilterBase': '_types/analysis/token_filters.ts#L39-L41', -'_types.analysis.TokenFilterDefinition': '_types/analysis/token_filters.ts#L349-L401', -'_types.analysis.Tokenizer': '_types/analysis/tokenizers.ts#L140-L142', +'_types.analysis.TokenFilterDefinition': '_types/analysis/token_filters.ts#L352-L404', +'_types.analysis.Tokenizer': '_types/analysis/tokenizers.ts#L140-L145', '_types.analysis.TokenizerBase': '_types/analysis/tokenizers.ts#L27-L29', -'_types.analysis.TokenizerDefinition': '_types/analysis/tokenizers.ts#L144-L167', +'_types.analysis.TokenizerDefinition': '_types/analysis/tokenizers.ts#L147-L170', '_types.analysis.TrimTokenFilter': '_types/analysis/token_filters.ts#L327-L329', '_types.analysis.TruncateTokenFilter': '_types/analysis/token_filters.ts#L331-L334', '_types.analysis.TurkishAnalyzer': '_types/analysis/analyzers.ts#L299-L304', @@ -862,46 +862,46 @@ '_types.mapping.UnsignedLongNumberProperty': '_types/mapping/core.ts#L177-L180', '_types.mapping.VersionProperty': '_types/mapping/core.ts#L289-L291', '_types.mapping.WildcardProperty': '_types/mapping/core.ts#L293-L300', -'_types.query_dsl.BoolQuery': '_types/query_dsl/compound.ts#L29-L53', -'_types.query_dsl.BoostingQuery': '_types/query_dsl/compound.ts#L55-L68', +'_types.query_dsl.BoolQuery': '_types/query_dsl/compound.ts#L29-L56', +'_types.query_dsl.BoostingQuery': '_types/query_dsl/compound.ts#L58-L74', '_types.query_dsl.ChildScoreMode': '_types/query_dsl/joining.ts#L25-L39', -'_types.query_dsl.CombinedFieldsOperator': '_types/query_dsl/abstractions.ts#L509-L512', +'_types.query_dsl.CombinedFieldsOperator': '_types/query_dsl/abstractions.ts#L512-L515', '_types.query_dsl.CombinedFieldsQuery': '_types/query_dsl/abstractions.ts#L465-L499', -'_types.query_dsl.CombinedFieldsZeroTerms': '_types/query_dsl/abstractions.ts#L514-L523', +'_types.query_dsl.CombinedFieldsZeroTerms': '_types/query_dsl/abstractions.ts#L517-L526', '_types.query_dsl.CommonTermsQuery': '_types/query_dsl/fulltext.ts#L34-L44', -'_types.query_dsl.ConstantScoreQuery': '_types/query_dsl/compound.ts#L70-L77', -'_types.query_dsl.DateDecayFunction': '_types/query_dsl/compound.ts#L196-L196', +'_types.query_dsl.ConstantScoreQuery': '_types/query_dsl/compound.ts#L76-L86', +'_types.query_dsl.DateDecayFunction': '_types/query_dsl/compound.ts#L209-L209', '_types.query_dsl.DateDistanceFeatureQuery': '_types/query_dsl/specialized.ts#L71-L74', -'_types.query_dsl.DateRangeQuery': '_types/query_dsl/term.ts#L149-L158', -'_types.query_dsl.DecayFunction': '_types/query_dsl/compound.ts#L202-L211', -'_types.query_dsl.DecayFunctionBase': '_types/query_dsl/compound.ts#L178-L189', -'_types.query_dsl.DecayPlacement': '_types/query_dsl/compound.ts#L157-L176', -'_types.query_dsl.DisMaxQuery': '_types/query_dsl/compound.ts#L79-L91', -'_types.query_dsl.DistanceFeatureQuery': '_types/query_dsl/specialized.ts#L76-L84', +'_types.query_dsl.DateRangeQuery': '_types/query_dsl/term.ts#L161-L170', +'_types.query_dsl.DecayFunction': '_types/query_dsl/compound.ts#L215-L224', +'_types.query_dsl.DecayFunctionBase': '_types/query_dsl/compound.ts#L191-L202', +'_types.query_dsl.DecayPlacement': '_types/query_dsl/compound.ts#L170-L189', +'_types.query_dsl.DisMaxQuery': '_types/query_dsl/compound.ts#L88-L103', +'_types.query_dsl.DistanceFeatureQuery': '_types/query_dsl/specialized.ts#L76-L85', '_types.query_dsl.DistanceFeatureQueryBase': '_types/query_dsl/specialized.ts#L39-L59', -'_types.query_dsl.ExistsQuery': '_types/query_dsl/term.ts#L38-L43', -'_types.query_dsl.FieldAndFormat': '_types/query_dsl/abstractions.ts#L525-L539', +'_types.query_dsl.ExistsQuery': '_types/query_dsl/term.ts#L38-L46', +'_types.query_dsl.FieldAndFormat': '_types/query_dsl/abstractions.ts#L528-L542', '_types.query_dsl.FieldLookup': '_types/query_dsl/abstractions.ts#L429-L446', -'_types.query_dsl.FieldValueFactorModifier': '_types/query_dsl/compound.ts#L310-L353', -'_types.query_dsl.FieldValueFactorScoreFunction': '_types/query_dsl/compound.ts#L136-L155', -'_types.query_dsl.FunctionBoostMode': '_types/query_dsl/compound.ts#L282-L308', -'_types.query_dsl.FunctionScoreContainer': '_types/query_dsl/compound.ts#L213-L253', -'_types.query_dsl.FunctionScoreMode': '_types/query_dsl/compound.ts#L255-L280', -'_types.query_dsl.FunctionScoreQuery': '_types/query_dsl/compound.ts#L93-L122', -'_types.query_dsl.FuzzyQuery': '_types/query_dsl/term.ts#L45-L80', -'_types.query_dsl.GeoBoundingBoxQuery': '_types/query_dsl/geo.ts#L32-L53', -'_types.query_dsl.GeoDecayFunction': '_types/query_dsl/compound.ts#L197-L200', +'_types.query_dsl.FieldValueFactorModifier': '_types/query_dsl/compound.ts#L323-L366', +'_types.query_dsl.FieldValueFactorScoreFunction': '_types/query_dsl/compound.ts#L149-L168', +'_types.query_dsl.FunctionBoostMode': '_types/query_dsl/compound.ts#L295-L321', +'_types.query_dsl.FunctionScoreContainer': '_types/query_dsl/compound.ts#L226-L266', +'_types.query_dsl.FunctionScoreMode': '_types/query_dsl/compound.ts#L268-L293', +'_types.query_dsl.FunctionScoreQuery': '_types/query_dsl/compound.ts#L105-L135', +'_types.query_dsl.FuzzyQuery': '_types/query_dsl/term.ts#L48-L86', +'_types.query_dsl.GeoBoundingBoxQuery': '_types/query_dsl/geo.ts#L32-L54', +'_types.query_dsl.GeoDecayFunction': '_types/query_dsl/compound.ts#L210-L213', '_types.query_dsl.GeoDistanceFeatureQuery': '_types/query_dsl/specialized.ts#L66-L69', -'_types.query_dsl.GeoDistanceQuery': '_types/query_dsl/geo.ts#L60-L91', -'_types.query_dsl.GeoExecution': '_types/query_dsl/geo.ts#L55-L58', -'_types.query_dsl.GeoPolygonPoints': '_types/query_dsl/geo.ts#L93-L95', -'_types.query_dsl.GeoPolygonQuery': '_types/query_dsl/geo.ts#L97-L108', -'_types.query_dsl.GeoShapeFieldQuery': '_types/query_dsl/geo.ts#L115-L126', -'_types.query_dsl.GeoShapeQuery': '_types/query_dsl/geo.ts#L128-L143', -'_types.query_dsl.GeoValidationMethod': '_types/query_dsl/geo.ts#L159-L169', -'_types.query_dsl.HasChildQuery': '_types/query_dsl/joining.ts#L41-L76', -'_types.query_dsl.HasParentQuery': '_types/query_dsl/joining.ts#L78-L104', -'_types.query_dsl.IdsQuery': '_types/query_dsl/term.ts#L82-L87', +'_types.query_dsl.GeoDistanceQuery': '_types/query_dsl/geo.ts#L61-L93', +'_types.query_dsl.GeoExecution': '_types/query_dsl/geo.ts#L56-L59', +'_types.query_dsl.GeoPolygonPoints': '_types/query_dsl/geo.ts#L95-L97', +'_types.query_dsl.GeoPolygonQuery': '_types/query_dsl/geo.ts#L99-L111', +'_types.query_dsl.GeoShapeFieldQuery': '_types/query_dsl/geo.ts#L118-L129', +'_types.query_dsl.GeoShapeQuery': '_types/query_dsl/geo.ts#L131-L147', +'_types.query_dsl.GeoValidationMethod': '_types/query_dsl/geo.ts#L163-L173', +'_types.query_dsl.HasChildQuery': '_types/query_dsl/joining.ts#L41-L79', +'_types.query_dsl.HasParentQuery': '_types/query_dsl/joining.ts#L81-L110', +'_types.query_dsl.IdsQuery': '_types/query_dsl/term.ts#L88-L96', '_types.query_dsl.IntervalsAllOf': '_types/query_dsl/fulltext.ts#L50-L70', '_types.query_dsl.IntervalsAnyOf': '_types/query_dsl/fulltext.ts#L72-L81', '_types.query_dsl.IntervalsContainer': '_types/query_dsl/fulltext.ts#L83-L110', @@ -909,90 +909,90 @@ '_types.query_dsl.IntervalsFuzzy': '_types/query_dsl/fulltext.ts#L154-L184', '_types.query_dsl.IntervalsMatch': '_types/query_dsl/fulltext.ts#L186-L216', '_types.query_dsl.IntervalsPrefix': '_types/query_dsl/fulltext.ts#L218-L233', -'_types.query_dsl.IntervalsQuery': '_types/query_dsl/fulltext.ts#L235-L263', -'_types.query_dsl.IntervalsWildcard': '_types/query_dsl/fulltext.ts#L265-L280', -'_types.query_dsl.Like': '_types/query_dsl/specialized.ts#L194-L199', -'_types.query_dsl.LikeDocument': '_types/query_dsl/specialized.ts#L170-L192', -'_types.query_dsl.MatchAllQuery': '_types/query_dsl/MatchAllQuery.ts#L22-L22', -'_types.query_dsl.MatchBoolPrefixQuery': '_types/query_dsl/fulltext.ts#L349-L403', -'_types.query_dsl.MatchNoneQuery': '_types/query_dsl/MatchNoneQuery.ts#L22-L22', -'_types.query_dsl.MatchPhrasePrefixQuery': '_types/query_dsl/fulltext.ts#L428-L454', -'_types.query_dsl.MatchPhraseQuery': '_types/query_dsl/fulltext.ts#L405-L426', -'_types.query_dsl.MatchQuery': '_types/query_dsl/fulltext.ts#L282-L347', -'_types.query_dsl.MoreLikeThisQuery': '_types/query_dsl/specialized.ts#L86-L168', -'_types.query_dsl.MultiMatchQuery': '_types/query_dsl/fulltext.ts#L456-L539', -'_types.query_dsl.MultiValueMode': '_types/query_dsl/compound.ts#L355-L372', -'_types.query_dsl.NestedQuery': '_types/query_dsl/joining.ts#L106-L130', -'_types.query_dsl.NumberRangeQuery': '_types/query_dsl/term.ts#L160-L160', -'_types.query_dsl.NumericDecayFunction': '_types/query_dsl/compound.ts#L195-L195', +'_types.query_dsl.IntervalsQuery': '_types/query_dsl/fulltext.ts#L235-L266', +'_types.query_dsl.IntervalsWildcard': '_types/query_dsl/fulltext.ts#L268-L283', +'_types.query_dsl.Like': '_types/query_dsl/specialized.ts#L198-L203', +'_types.query_dsl.LikeDocument': '_types/query_dsl/specialized.ts#L174-L196', +'_types.query_dsl.MatchAllQuery': '_types/query_dsl/MatchAllQuery.ts#L22-L25', +'_types.query_dsl.MatchBoolPrefixQuery': '_types/query_dsl/fulltext.ts#L355-L412', +'_types.query_dsl.MatchNoneQuery': '_types/query_dsl/MatchNoneQuery.ts#L22-L25', +'_types.query_dsl.MatchPhrasePrefixQuery': '_types/query_dsl/fulltext.ts#L440-L469', +'_types.query_dsl.MatchPhraseQuery': '_types/query_dsl/fulltext.ts#L414-L438', +'_types.query_dsl.MatchQuery': '_types/query_dsl/fulltext.ts#L285-L353', +'_types.query_dsl.MoreLikeThisQuery': '_types/query_dsl/specialized.ts#L87-L172', +'_types.query_dsl.MultiMatchQuery': '_types/query_dsl/fulltext.ts#L471-L557', +'_types.query_dsl.MultiValueMode': '_types/query_dsl/compound.ts#L368-L385', +'_types.query_dsl.NestedQuery': '_types/query_dsl/joining.ts#L112-L139', +'_types.query_dsl.NumberRangeQuery': '_types/query_dsl/term.ts#L172-L172', +'_types.query_dsl.NumericDecayFunction': '_types/query_dsl/compound.ts#L208-L208', '_types.query_dsl.Operator': '_types/query_dsl/Operator.ts#L22-L27', -'_types.query_dsl.ParentIdQuery': '_types/query_dsl/joining.ts#L132-L146', -'_types.query_dsl.PercolateQuery': '_types/query_dsl/specialized.ts#L201-L238', -'_types.query_dsl.PinnedDoc': '_types/query_dsl/specialized.ts#L261-L270', -'_types.query_dsl.PinnedQuery': '_types/query_dsl/specialized.ts#L240-L259', -'_types.query_dsl.PrefixQuery': '_types/query_dsl/term.ts#L89-L108', +'_types.query_dsl.ParentIdQuery': '_types/query_dsl/joining.ts#L141-L158', +'_types.query_dsl.PercolateQuery': '_types/query_dsl/specialized.ts#L205-L245', +'_types.query_dsl.PinnedDoc': '_types/query_dsl/specialized.ts#L269-L278', +'_types.query_dsl.PinnedQuery': '_types/query_dsl/specialized.ts#L247-L267', +'_types.query_dsl.PrefixQuery': '_types/query_dsl/term.ts#L98-L120', '_types.query_dsl.QueryBase': '_types/query_dsl/abstractions.ts#L452-L463', '_types.query_dsl.QueryContainer': '_types/query_dsl/abstractions.ts#L102-L427', -'_types.query_dsl.QueryStringQuery': '_types/query_dsl/fulltext.ts#L580-L700', -'_types.query_dsl.RandomScoreFunction': '_types/query_dsl/compound.ts#L131-L134', -'_types.query_dsl.RangeQuery': '_types/query_dsl/term.ts#L164-L173', -'_types.query_dsl.RangeQueryBase': '_types/query_dsl/term.ts#L110-L136', -'_types.query_dsl.RangeRelation': '_types/query_dsl/term.ts#L175-L188', -'_types.query_dsl.RankFeatureFunction': '_types/query_dsl/specialized.ts#L272-L272', -'_types.query_dsl.RankFeatureFunctionLinear': '_types/query_dsl/specialized.ts#L274-L274', -'_types.query_dsl.RankFeatureFunctionLogarithm': '_types/query_dsl/specialized.ts#L276-L281', -'_types.query_dsl.RankFeatureFunctionSaturation': '_types/query_dsl/specialized.ts#L283-L288', -'_types.query_dsl.RankFeatureFunctionSigmoid': '_types/query_dsl/specialized.ts#L290-L299', -'_types.query_dsl.RankFeatureQuery': '_types/query_dsl/specialized.ts#L301-L324', -'_types.query_dsl.RegexpQuery': '_types/query_dsl/term.ts#L190-L220', -'_types.query_dsl.RuleQuery': '_types/query_dsl/specialized.ts#L380-L384', -'_types.query_dsl.ScriptQuery': '_types/query_dsl/specialized.ts#L326-L332', -'_types.query_dsl.ScriptScoreFunction': '_types/query_dsl/compound.ts#L124-L129', -'_types.query_dsl.ScriptScoreQuery': '_types/query_dsl/specialized.ts#L334-L348', -'_types.query_dsl.SemanticQuery': '_types/query_dsl/SemanticQuery.ts#L22-L27', -'_types.query_dsl.ShapeFieldQuery': '_types/query_dsl/specialized.ts#L365-L378', -'_types.query_dsl.ShapeQuery': '_types/query_dsl/specialized.ts#L350-L363', -'_types.query_dsl.SimpleQueryStringFlag': '_types/query_dsl/fulltext.ts#L708-L763', -'_types.query_dsl.SimpleQueryStringQuery': '_types/query_dsl/fulltext.ts#L765-L830', -'_types.query_dsl.SpanContainingQuery': '_types/query_dsl/span.ts#L25-L36', -'_types.query_dsl.SpanFieldMaskingQuery': '_types/query_dsl/span.ts#L38-L41', -'_types.query_dsl.SpanFirstQuery': '_types/query_dsl/span.ts#L43-L52', -'_types.query_dsl.SpanMultiTermQuery': '_types/query_dsl/span.ts#L58-L63', -'_types.query_dsl.SpanNearQuery': '_types/query_dsl/span.ts#L65-L78', -'_types.query_dsl.SpanNotQuery': '_types/query_dsl/span.ts#L80-L104', -'_types.query_dsl.SpanOrQuery': '_types/query_dsl/span.ts#L106-L111', -'_types.query_dsl.SpanQuery': '_types/query_dsl/span.ts#L131-L173', -'_types.query_dsl.SpanTermQuery': '_types/query_dsl/span.ts#L113-L116', -'_types.query_dsl.SpanWithinQuery': '_types/query_dsl/span.ts#L118-L129', -'_types.query_dsl.SparseVectorQuery': '_types/query_dsl/SparseVectorQuery.ts#L26-L79', -'_types.query_dsl.TermQuery': '_types/query_dsl/term.ts#L222-L236', -'_types.query_dsl.TermRangeQuery': '_types/query_dsl/term.ts#L162-L162', -'_types.query_dsl.TermsLookup': '_types/query_dsl/term.ts#L250-L255', -'_types.query_dsl.TermsQuery': '_types/query_dsl/term.ts#L238-L243', -'_types.query_dsl.TermsQueryField': '_types/query_dsl/term.ts#L245-L248', -'_types.query_dsl.TermsSetQuery': '_types/query_dsl/term.ts#L257-L276', -'_types.query_dsl.TextExpansionQuery': '_types/query_dsl/TextExpansionQuery.ts#L23-L33', -'_types.query_dsl.TextQueryType': '_types/query_dsl/fulltext.ts#L541-L567', +'_types.query_dsl.QueryStringQuery': '_types/query_dsl/fulltext.ts#L598-L721', +'_types.query_dsl.RandomScoreFunction': '_types/query_dsl/compound.ts#L144-L147', +'_types.query_dsl.RangeQuery': '_types/query_dsl/term.ts#L176-L186', +'_types.query_dsl.RangeQueryBase': '_types/query_dsl/term.ts#L122-L148', +'_types.query_dsl.RangeRelation': '_types/query_dsl/term.ts#L188-L201', +'_types.query_dsl.RankFeatureFunction': '_types/query_dsl/specialized.ts#L280-L280', +'_types.query_dsl.RankFeatureFunctionLinear': '_types/query_dsl/specialized.ts#L282-L282', +'_types.query_dsl.RankFeatureFunctionLogarithm': '_types/query_dsl/specialized.ts#L284-L289', +'_types.query_dsl.RankFeatureFunctionSaturation': '_types/query_dsl/specialized.ts#L291-L296', +'_types.query_dsl.RankFeatureFunctionSigmoid': '_types/query_dsl/specialized.ts#L298-L307', +'_types.query_dsl.RankFeatureQuery': '_types/query_dsl/specialized.ts#L309-L335', +'_types.query_dsl.RegexpQuery': '_types/query_dsl/term.ts#L203-L236', +'_types.query_dsl.RuleQuery': '_types/query_dsl/specialized.ts#L398-L405', +'_types.query_dsl.ScriptQuery': '_types/query_dsl/specialized.ts#L337-L346', +'_types.query_dsl.ScriptScoreFunction': '_types/query_dsl/compound.ts#L137-L142', +'_types.query_dsl.ScriptScoreQuery': '_types/query_dsl/specialized.ts#L348-L365', +'_types.query_dsl.SemanticQuery': '_types/query_dsl/SemanticQuery.ts#L22-L30', +'_types.query_dsl.ShapeFieldQuery': '_types/query_dsl/specialized.ts#L383-L396', +'_types.query_dsl.ShapeQuery': '_types/query_dsl/specialized.ts#L367-L381', +'_types.query_dsl.SimpleQueryStringFlag': '_types/query_dsl/fulltext.ts#L729-L784', +'_types.query_dsl.SimpleQueryStringQuery': '_types/query_dsl/fulltext.ts#L786-L854', +'_types.query_dsl.SpanContainingQuery': '_types/query_dsl/span.ts#L25-L39', +'_types.query_dsl.SpanFieldMaskingQuery': '_types/query_dsl/span.ts#L41-L47', +'_types.query_dsl.SpanFirstQuery': '_types/query_dsl/span.ts#L49-L61', +'_types.query_dsl.SpanMultiTermQuery': '_types/query_dsl/span.ts#L67-L75', +'_types.query_dsl.SpanNearQuery': '_types/query_dsl/span.ts#L77-L93', +'_types.query_dsl.SpanNotQuery': '_types/query_dsl/span.ts#L95-L122', +'_types.query_dsl.SpanOrQuery': '_types/query_dsl/span.ts#L124-L132', +'_types.query_dsl.SpanQuery': '_types/query_dsl/span.ts#L158-L200', +'_types.query_dsl.SpanTermQuery': '_types/query_dsl/span.ts#L134-L140', +'_types.query_dsl.SpanWithinQuery': '_types/query_dsl/span.ts#L142-L156', +'_types.query_dsl.SparseVectorQuery': '_types/query_dsl/SparseVectorQuery.ts#L26-L80', +'_types.query_dsl.TermQuery': '_types/query_dsl/term.ts#L238-L255', +'_types.query_dsl.TermRangeQuery': '_types/query_dsl/term.ts#L174-L174', +'_types.query_dsl.TermsLookup': '_types/query_dsl/term.ts#L270-L275', +'_types.query_dsl.TermsQuery': '_types/query_dsl/term.ts#L257-L263', +'_types.query_dsl.TermsQueryField': '_types/query_dsl/term.ts#L265-L268', +'_types.query_dsl.TermsSetQuery': '_types/query_dsl/term.ts#L277-L299', +'_types.query_dsl.TextExpansionQuery': '_types/query_dsl/TextExpansionQuery.ts#L23-L36', +'_types.query_dsl.TextQueryType': '_types/query_dsl/fulltext.ts#L559-L585', '_types.query_dsl.TokenPruningConfig': '_types/query_dsl/TokenPruningConfig.ts#L22-L35', -'_types.query_dsl.TypeQuery': '_types/query_dsl/term.ts#L278-L280', -'_types.query_dsl.UntypedDecayFunction': '_types/query_dsl/compound.ts#L191-L194', +'_types.query_dsl.TypeQuery': '_types/query_dsl/term.ts#L301-L303', +'_types.query_dsl.UntypedDecayFunction': '_types/query_dsl/compound.ts#L204-L207', '_types.query_dsl.UntypedDistanceFeatureQuery': '_types/query_dsl/specialized.ts#L61-L64', -'_types.query_dsl.UntypedRangeQuery': '_types/query_dsl/term.ts#L138-L147', -'_types.query_dsl.WeightedTokensQuery': '_types/query_dsl/WeightedTokensQuery.ts#L25-L30', -'_types.query_dsl.WildcardQuery': '_types/query_dsl/term.ts#L282-L299', -'_types.query_dsl.WrapperQuery': '_types/query_dsl/abstractions.ts#L501-L507', -'_types.query_dsl.ZeroTermsQuery': '_types/query_dsl/fulltext.ts#L569-L578', +'_types.query_dsl.UntypedRangeQuery': '_types/query_dsl/term.ts#L150-L159', +'_types.query_dsl.WeightedTokensQuery': '_types/query_dsl/WeightedTokensQuery.ts#L25-L33', +'_types.query_dsl.WildcardQuery': '_types/query_dsl/term.ts#L305-L325', +'_types.query_dsl.WrapperQuery': '_types/query_dsl/abstractions.ts#L501-L510', +'_types.query_dsl.ZeroTermsQuery': '_types/query_dsl/fulltext.ts#L587-L596', 'async_search._types.AsyncSearch': 'async_search/_types/AsyncSearch.ts#L30-L56', 'async_search._types.AsyncSearchDocumentResponseBase': 'async_search/_types/AsyncSearchResponseBase.ts#L50-L54', 'async_search._types.AsyncSearchResponseBase': 'async_search/_types/AsyncSearchResponseBase.ts#L24-L49', 'async_search.delete.Request': 'async_search/delete/AsyncSearchDeleteRequest.ts#L23-L39', 'async_search.delete.Response': 'async_search/delete/AsyncSearchDeleteResponse.ts#L22-L24', -'async_search.get.Request': 'async_search/get/AsyncSearchGetRequest.ts#L24-L55', +'async_search.get.Request': 'async_search/get/AsyncSearchGetRequest.ts#L24-L56', 'async_search.get.Response': 'async_search/get/AsyncSearchGetResponse.ts#L22-L24', 'async_search.status.Request': 'async_search/status/AsyncSearchStatusRequest.ts#L23-L38', 'async_search.status.Response': 'async_search/status/AsyncSearchStatusResponse.ts#L39-L41', 'async_search.status.StatusResponseBase': 'async_search/status/AsyncSearchStatusResponse.ts#L24-L38', -'async_search.submit.Request': 'async_search/submit/AsyncSearchSubmitRequest.ts#L55-L287', +'async_search.submit.Request': 'async_search/submit/AsyncSearchSubmitRequest.ts#L55-L289', 'async_search.submit.Response': 'async_search/submit/AsyncSearchSubmitResponse.ts#L22-L24', 'autoscaling._types.AutoscalingPolicy': 'autoscaling/_types/AutoscalingPolicy.ts#L23-L27', 'autoscaling.delete_autoscaling_policy.Request': 'autoscaling/delete_autoscaling_policy/DeleteAutoscalingPolicyRequest.ts#L23-L32', @@ -1254,47 +1254,47 @@ 'connector._types.SyncRulesFeature': 'connector/_types/Connector.ts#L219-L222', 'connector._types.SyncStatus': 'connector/_types/Connector.ts#L138-L146', 'connector._types.Validation': 'connector/_types/Connector.ts#L50-L56', -'connector.check_in.Request': 'connector/check_in/ConnectorCheckInRequest.ts#L22-L36', +'connector.check_in.Request': 'connector/check_in/ConnectorCheckInRequest.ts#L22-L38', 'connector.check_in.Response': 'connector/check_in/ConnectorCheckInResponse.ts#L22-L26', -'connector.delete.Request': 'connector/delete/ConnectorDeleteRequest.ts#L22-L42', +'connector.delete.Request': 'connector/delete/ConnectorDeleteRequest.ts#L22-L47', 'connector.delete.Response': 'connector/delete/ConnectorDeleteResponse.ts#L22-L24', -'connector.get.Request': 'connector/get/ConnectorGetRequest.ts#L22-L36', +'connector.get.Request': 'connector/get/ConnectorGetRequest.ts#L22-L38', 'connector.get.Response': 'connector/get/ConnectorGetResponse.ts#L22-L24', -'connector.list.Request': 'connector/list/ConnectorListRequest.ts#L23-L57', +'connector.list.Request': 'connector/list/ConnectorListRequest.ts#L23-L59', 'connector.list.Response': 'connector/list/ConnectorListResponse.ts#L23-L28', -'connector.post.Request': 'connector/post/ConnectorPostRequest.ts#L22-L42', +'connector.post.Request': 'connector/post/ConnectorPostRequest.ts#L22-L46', 'connector.post.Response': 'connector/post/ConnectorPostResponse.ts#L23-L28', 'connector.put.Request': 'connector/put/ConnectorPutRequest.ts#L22-L48', 'connector.put.Response': 'connector/put/ConnectorPutResponse.ts#L23-L28', -'connector.sync_job_cancel.Request': 'connector/sync_job_cancel/SyncJobCancelRequest.ts#L22-L36', +'connector.sync_job_cancel.Request': 'connector/sync_job_cancel/SyncJobCancelRequest.ts#L22-L39', 'connector.sync_job_cancel.Response': 'connector/sync_job_cancel/SyncJobCancelResponse.ts#L22-L26', -'connector.sync_job_delete.Request': 'connector/sync_job_delete/SyncJobDeleteRequest.ts#L22-L36', +'connector.sync_job_delete.Request': 'connector/sync_job_delete/SyncJobDeleteRequest.ts#L22-L39', 'connector.sync_job_delete.Response': 'connector/sync_job_delete/SyncJobDeleteResponse.ts#L22-L24', 'connector.sync_job_get.Request': 'connector/sync_job_get/SyncJobGetRequest.ts#L22-L36', 'connector.sync_job_get.Response': 'connector/sync_job_get/SyncJobGetResponse.ts#L22-L24', -'connector.sync_job_list.Request': 'connector/sync_job_list/SyncJobListRequest.ts#L25-L55', +'connector.sync_job_list.Request': 'connector/sync_job_list/SyncJobListRequest.ts#L25-L57', 'connector.sync_job_list.Response': 'connector/sync_job_list/SyncJobListResponse.ts#L23-L28', -'connector.sync_job_post.Request': 'connector/sync_job_post/SyncJobPostRequest.ts#L23-L43', +'connector.sync_job_post.Request': 'connector/sync_job_post/SyncJobPostRequest.ts#L23-L45', 'connector.sync_job_post.Response': 'connector/sync_job_post/SyncJobPostResponse.ts#L22-L26', -'connector.update_active_filtering.Request': 'connector/update_active_filtering/ConnectorUpdateActiveFilteringRequest.ts#L22-L36', +'connector.update_active_filtering.Request': 'connector/update_active_filtering/ConnectorUpdateActiveFilteringRequest.ts#L22-L38', 'connector.update_active_filtering.Response': 'connector/update_active_filtering/ConnectorUpdateActiveFilteringResponse.ts#L22-L26', -'connector.update_api_key_id.Request': 'connector/update_api_key_id/ConnectorUpdateAPIKeyIDRequest.ts#L21-L42', +'connector.update_api_key_id.Request': 'connector/update_api_key_id/ConnectorUpdateAPIKeyIDRequest.ts#L21-L47', 'connector.update_api_key_id.Response': 'connector/update_api_key_id/ConnectorUpdateAPIKeyIDResponse.ts#L22-L26', -'connector.update_configuration.Request': 'connector/update_configuration/ConnectorUpdateConfigurationRequest.ts#L25-L47', +'connector.update_configuration.Request': 'connector/update_configuration/ConnectorUpdateConfigurationRequest.ts#L25-L49', 'connector.update_configuration.Response': 'connector/update_configuration/ConnectorUpdateConfigurationResponse.ts#L22-L26', -'connector.update_error.Request': 'connector/update_error/ConnectorUpdateErrorRequest.ts#L23-L44', +'connector.update_error.Request': 'connector/update_error/ConnectorUpdateErrorRequest.ts#L23-L48', 'connector.update_error.Response': 'connector/update_error/ConnectorUpdateErrorResponse.ts#L22-L26', -'connector.update_filtering.Request': 'connector/update_filtering/ConnectorUpdateFilteringRequest.ts#L27-L50', +'connector.update_filtering.Request': 'connector/update_filtering/ConnectorUpdateFilteringRequest.ts#L27-L54', 'connector.update_filtering.Response': 'connector/update_filtering/ConnectorUpdateFilteringResponse.ts#L22-L26', -'connector.update_filtering_validation.Request': 'connector/update_filtering_validation/ConnectorUpdateFilteringValidationRequest.ts#L23-L40', +'connector.update_filtering_validation.Request': 'connector/update_filtering_validation/ConnectorUpdateFilteringValidationRequest.ts#L23-L42', 'connector.update_filtering_validation.Response': 'connector/update_filtering_validation/ConnectorUpdateFilteringValidationResponse.ts#L22-L26', -'connector.update_index_name.Request': 'connector/update_index_name/ConnectorUpdateIndexNameRequest.ts#L23-L43', +'connector.update_index_name.Request': 'connector/update_index_name/ConnectorUpdateIndexNameRequest.ts#L23-L45', 'connector.update_index_name.Response': 'connector/update_index_name/ConnectorUpdateIndexNameResponse.ts#L22-L26', 'connector.update_name.Request': 'connector/update_name/ConnectorUpdateNameRequest.ts#L22-L43', 'connector.update_name.Response': 'connector/update_name/ConnectorUpdateNameResponse.ts#L22-L26', 'connector.update_native.Request': 'connector/update_native/ConnectorUpdateNativeRequest.ts#L22-L42', 'connector.update_native.Response': 'connector/update_native/ConnectorUpdateNativeResponse.ts#L22-L26', -'connector.update_pipeline.Request': 'connector/update_pipeline/ConnectorUpdatePipelineRequest.ts#L23-L44', +'connector.update_pipeline.Request': 'connector/update_pipeline/ConnectorUpdatePipelineRequest.ts#L23-L46', 'connector.update_pipeline.Response': 'connector/update_pipeline/ConnectorUpdatePipelineResponse.ts#L22-L26', 'connector.update_scheduling.Request': 'connector/update_scheduling/ConnectorUpdateSchedulingRequest.ts#L23-L44', 'connector.update_scheduling.Response': 'connector/update_scheduling/ConnectorUpdateSchedulingResponse.ts#L22-L26', @@ -1302,12 +1302,12 @@ 'connector.update_service_type.Response': 'connector/update_service_type/ConnectorUpdateServiceTypeResponse.ts#L22-L26', 'connector.update_status.Request': 'connector/update_status/ConnectorUpdateStatusRequest.ts#L23-L43', 'connector.update_status.Response': 'connector/update_status/ConnectorUpdateStatusResponse.ts#L22-L26', -'dangling_indices.delete_dangling_index.Request': 'dangling_indices/delete_dangling_index/DeleteDanglingIndexRequest.ts#L24-L37', +'dangling_indices.delete_dangling_index.Request': 'dangling_indices/delete_dangling_index/DeleteDanglingIndexRequest.ts#L24-L48', 'dangling_indices.delete_dangling_index.Response': 'dangling_indices/delete_dangling_index/DeleteDanglingIndexResponse.ts#L22-L24', -'dangling_indices.import_dangling_index.Request': 'dangling_indices/import_dangling_index/ImportDanglingIndexRequest.ts#L24-L37', +'dangling_indices.import_dangling_index.Request': 'dangling_indices/import_dangling_index/ImportDanglingIndexRequest.ts#L24-L49', 'dangling_indices.import_dangling_index.Response': 'dangling_indices/import_dangling_index/ImportDanglingIndexResponse.ts#L22-L24', 'dangling_indices.list_dangling_indices.DanglingIndex': 'dangling_indices/list_dangling_indices/ListDanglingIndicesResponse.ts#L29-L34', -'dangling_indices.list_dangling_indices.Request': 'dangling_indices/list_dangling_indices/ListDanglingIndicesRequest.ts#L22-L26', +'dangling_indices.list_dangling_indices.Request': 'dangling_indices/list_dangling_indices/ListDanglingIndicesRequest.ts#L22-L33', 'dangling_indices.list_dangling_indices.Response': 'dangling_indices/list_dangling_indices/ListDanglingIndicesResponse.ts#L23-L27', 'enrich._types.Policy': 'enrich/_types/Policy.ts#L34-L41', 'enrich._types.PolicyType': 'enrich/_types/Policy.ts#L28-L32', @@ -1492,7 +1492,7 @@ 'indices.analyze.AnalyzerDetail': 'indices/analyze/types.ts#L32-L35', 'indices.analyze.CharFilterDetail': 'indices/analyze/types.ts#L46-L49', 'indices.analyze.ExplainAnalyzeToken': 'indices/analyze/types.ts#L52-L67', -'indices.analyze.Request': 'indices/analyze/IndicesAnalyzeRequest.ts#L27-L92', +'indices.analyze.Request': 'indices/analyze/IndicesAnalyzeRequest.ts#L27-L93', 'indices.analyze.Response': 'indices/analyze/IndicesAnalyzeResponse.ts#L22-L27', 'indices.analyze.TokenDetail': 'indices/analyze/types.ts#L71-L74', 'indices.clear_cache.Request': 'indices/clear_cache/IndicesIndicesClearCacheRequest.ts#L23-L77', @@ -1693,60 +1693,65 @@ 'inference.inference.Response': 'inference/inference/InferenceResponse.ts#L22-L24', 'inference.put.Request': 'inference/put/PutRequest.ts#L25-L44', 'inference.put.Response': 'inference/put/PutResponse.ts#L22-L24', -'ingest._types.AppendProcessor': 'ingest/_types/Processors.ts#L297-L312', -'ingest._types.AttachmentProcessor': 'ingest/_types/Processors.ts#L314-L355', -'ingest._types.BytesProcessor': 'ingest/_types/Processors.ts#L488-L504', -'ingest._types.CircleProcessor': 'ingest/_types/Processors.ts#L506-L529', -'ingest._types.ConvertProcessor': 'ingest/_types/Processors.ts#L541-L561', -'ingest._types.ConvertType': 'ingest/_types/Processors.ts#L531-L539', -'ingest._types.CsvProcessor': 'ingest/_types/Processors.ts#L563-L596', +'ingest._types.AppendProcessor': 'ingest/_types/Processors.ts#L324-L339', +'ingest._types.AttachmentProcessor': 'ingest/_types/Processors.ts#L341-L382', +'ingest._types.BytesProcessor': 'ingest/_types/Processors.ts#L515-L531', +'ingest._types.CircleProcessor': 'ingest/_types/Processors.ts#L533-L556', +'ingest._types.CommunityIDProcessor': 'ingest/_types/Processors.ts#L558-L619', +'ingest._types.ConvertProcessor': 'ingest/_types/Processors.ts#L632-L652', +'ingest._types.ConvertType': 'ingest/_types/Processors.ts#L621-L630', +'ingest._types.CsvProcessor': 'ingest/_types/Processors.ts#L654-L687', 'ingest._types.DatabaseConfiguration': 'ingest/_types/Database.ts#L22-L29', -'ingest._types.DateIndexNameProcessor': 'ingest/_types/Processors.ts#L598-L636', -'ingest._types.DateProcessor': 'ingest/_types/Processors.ts#L638-L665', -'ingest._types.DissectProcessor': 'ingest/_types/Processors.ts#L667-L686', -'ingest._types.DotExpanderProcessor': 'ingest/_types/Processors.ts#L688-L706', -'ingest._types.DropProcessor': 'ingest/_types/Processors.ts#L708-L708', -'ingest._types.EnrichProcessor': 'ingest/_types/Processors.ts#L710-L749', -'ingest._types.FailProcessor': 'ingest/_types/Processors.ts#L751-L757', -'ingest._types.ForeachProcessor': 'ingest/_types/Processors.ts#L759-L773', -'ingest._types.GeoGridProcessor': 'ingest/_types/Processors.ts#L357-L398', -'ingest._types.GeoGridTargetFormat': 'ingest/_types/Processors.ts#L406-L409', -'ingest._types.GeoGridTileType': 'ingest/_types/Processors.ts#L400-L404', -'ingest._types.GeoIpProcessor': 'ingest/_types/Processors.ts#L411-L445', -'ingest._types.GrokProcessor': 'ingest/_types/Processors.ts#L775-L800', -'ingest._types.GsubProcessor': 'ingest/_types/Processors.ts#L802-L826', -'ingest._types.HtmlStripProcessor': 'ingest/_types/Processors.ts#L828-L844', -'ingest._types.InferenceConfig': 'ingest/_types/Processors.ts#L867-L879', -'ingest._types.InferenceConfigClassification': 'ingest/_types/Processors.ts#L894-L920', -'ingest._types.InferenceConfigRegression': 'ingest/_types/Processors.ts#L881-L892', -'ingest._types.InferenceProcessor': 'ingest/_types/Processors.ts#L846-L865', -'ingest._types.JoinProcessor': 'ingest/_types/Processors.ts#L922-L937', -'ingest._types.JsonProcessor': 'ingest/_types/Processors.ts#L939-L968', -'ingest._types.JsonProcessorConflictStrategy': 'ingest/_types/Processors.ts#L970-L975', -'ingest._types.KeyValueProcessor': 'ingest/_types/Processors.ts#L977-L1029', -'ingest._types.LowercaseProcessor': 'ingest/_types/Processors.ts#L1031-L1047', +'ingest._types.DateIndexNameProcessor': 'ingest/_types/Processors.ts#L689-L727', +'ingest._types.DateProcessor': 'ingest/_types/Processors.ts#L729-L762', +'ingest._types.DissectProcessor': 'ingest/_types/Processors.ts#L764-L783', +'ingest._types.DotExpanderProcessor': 'ingest/_types/Processors.ts#L785-L803', +'ingest._types.DropProcessor': 'ingest/_types/Processors.ts#L805-L805', +'ingest._types.EnrichProcessor': 'ingest/_types/Processors.ts#L807-L846', +'ingest._types.FailProcessor': 'ingest/_types/Processors.ts#L848-L854', +'ingest._types.FingerprintDigest': 'ingest/_types/Processors.ts#L856-L862', +'ingest._types.FingerprintProcessor': 'ingest/_types/Processors.ts#L864-L892', +'ingest._types.ForeachProcessor': 'ingest/_types/Processors.ts#L894-L908', +'ingest._types.GeoGridProcessor': 'ingest/_types/Processors.ts#L384-L425', +'ingest._types.GeoGridTargetFormat': 'ingest/_types/Processors.ts#L433-L436', +'ingest._types.GeoGridTileType': 'ingest/_types/Processors.ts#L427-L431', +'ingest._types.GeoIpProcessor': 'ingest/_types/Processors.ts#L438-L472', +'ingest._types.GrokProcessor': 'ingest/_types/Processors.ts#L910-L941', +'ingest._types.GsubProcessor': 'ingest/_types/Processors.ts#L943-L967', +'ingest._types.HtmlStripProcessor': 'ingest/_types/Processors.ts#L969-L985', +'ingest._types.InferenceConfig': 'ingest/_types/Processors.ts#L1008-L1020', +'ingest._types.InferenceConfigClassification': 'ingest/_types/Processors.ts#L1035-L1061', +'ingest._types.InferenceConfigRegression': 'ingest/_types/Processors.ts#L1022-L1033', +'ingest._types.InferenceProcessor': 'ingest/_types/Processors.ts#L987-L1006', +'ingest._types.JoinProcessor': 'ingest/_types/Processors.ts#L1063-L1078', +'ingest._types.JsonProcessor': 'ingest/_types/Processors.ts#L1080-L1109', +'ingest._types.JsonProcessorConflictStrategy': 'ingest/_types/Processors.ts#L1111-L1116', +'ingest._types.KeyValueProcessor': 'ingest/_types/Processors.ts#L1118-L1170', +'ingest._types.LowercaseProcessor': 'ingest/_types/Processors.ts#L1172-L1188', 'ingest._types.Maxmind': 'ingest/_types/Database.ts#L31-L33', +'ingest._types.NetworkDirectionProcessor': 'ingest/_types/Processors.ts#L1190-L1224', 'ingest._types.Pipeline': 'ingest/_types/Pipeline.ts#L23-L51', -'ingest._types.PipelineProcessor': 'ingest/_types/Processors.ts#L1049-L1060', -'ingest._types.ProcessorBase': 'ingest/_types/Processors.ts#L272-L295', -'ingest._types.ProcessorContainer': 'ingest/_types/Processors.ts#L27-L270', -'ingest._types.RedactProcessor': 'ingest/_types/Processors.ts#L1062-L1103', -'ingest._types.RemoveProcessor': 'ingest/_types/Processors.ts#L1105-L1119', -'ingest._types.RenameProcessor': 'ingest/_types/Processors.ts#L1121-L1137', -'ingest._types.RerouteProcessor': 'ingest/_types/Processors.ts#L1139-L1167', -'ingest._types.ScriptProcessor': 'ingest/_types/Processors.ts#L1169-L1189', -'ingest._types.SetProcessor': 'ingest/_types/Processors.ts#L1191-L1225', -'ingest._types.SetSecurityUserProcessor': 'ingest/_types/Processors.ts#L1227-L1236', -'ingest._types.ShapeType': 'ingest/_types/Processors.ts#L1238-L1241', -'ingest._types.SortProcessor': 'ingest/_types/Processors.ts#L1243-L1259', -'ingest._types.SplitProcessor': 'ingest/_types/Processors.ts#L1261-L1286', -'ingest._types.TerminateProcessor': 'ingest/_types/Processors.ts#L1288-L1288', -'ingest._types.TrimProcessor': 'ingest/_types/Processors.ts#L1290-L1306', -'ingest._types.UppercaseProcessor': 'ingest/_types/Processors.ts#L1308-L1324', -'ingest._types.UriPartsProcessor': 'ingest/_types/Processors.ts#L1344-L1370', -'ingest._types.UrlDecodeProcessor': 'ingest/_types/Processors.ts#L1326-L1342', -'ingest._types.UserAgentProcessor': 'ingest/_types/Processors.ts#L447-L478', -'ingest._types.UserAgentProperty': 'ingest/_types/Processors.ts#L480-L486', +'ingest._types.PipelineProcessor': 'ingest/_types/Processors.ts#L1226-L1237', +'ingest._types.ProcessorBase': 'ingest/_types/Processors.ts#L299-L322', +'ingest._types.ProcessorContainer': 'ingest/_types/Processors.ts#L27-L297', +'ingest._types.RedactProcessor': 'ingest/_types/Processors.ts#L1239-L1280', +'ingest._types.RegisteredDomainProcessor': 'ingest/_types/Processors.ts#L1282-L1298', +'ingest._types.RemoveProcessor': 'ingest/_types/Processors.ts#L1300-L1314', +'ingest._types.RenameProcessor': 'ingest/_types/Processors.ts#L1316-L1332', +'ingest._types.RerouteProcessor': 'ingest/_types/Processors.ts#L1334-L1362', +'ingest._types.ScriptProcessor': 'ingest/_types/Processors.ts#L1364-L1384', +'ingest._types.SetProcessor': 'ingest/_types/Processors.ts#L1386-L1420', +'ingest._types.SetSecurityUserProcessor': 'ingest/_types/Processors.ts#L1422-L1431', +'ingest._types.ShapeType': 'ingest/_types/Processors.ts#L1433-L1436', +'ingest._types.SortProcessor': 'ingest/_types/Processors.ts#L1438-L1454', +'ingest._types.SplitProcessor': 'ingest/_types/Processors.ts#L1456-L1481', +'ingest._types.TerminateProcessor': 'ingest/_types/Processors.ts#L1483-L1483', +'ingest._types.TrimProcessor': 'ingest/_types/Processors.ts#L1485-L1501', +'ingest._types.UppercaseProcessor': 'ingest/_types/Processors.ts#L1503-L1519', +'ingest._types.UriPartsProcessor': 'ingest/_types/Processors.ts#L1539-L1565', +'ingest._types.UrlDecodeProcessor': 'ingest/_types/Processors.ts#L1521-L1537', +'ingest._types.UserAgentProcessor': 'ingest/_types/Processors.ts#L474-L505', +'ingest._types.UserAgentProperty': 'ingest/_types/Processors.ts#L507-L513', 'ingest.delete_geoip_database.Request': 'ingest/delete_geoip_database/DeleteGeoipDatabaseRequest.ts#L24-L48', 'ingest.delete_geoip_database.Response': 'ingest/delete_geoip_database/DeleteGeoipDatabaseResponse.ts#L22-L24', 'ingest.delete_pipeline.Request': 'ingest/delete_pipeline/DeletePipelineRequest.ts#L24-L52', @@ -1826,22 +1831,22 @@ 'ml._types.BucketSummary': 'ml/_types/Bucket.ts#L30-L77', 'ml._types.CalendarEvent': 'ml/_types/CalendarEvent.ts#L23-L33', 'ml._types.CategorizationAnalyzer': 'ml/_types/Analysis.ts#L181-L182', -'ml._types.CategorizationAnalyzerDefinition': 'ml/_types/Analysis.ts#L184-L197', +'ml._types.CategorizationAnalyzerDefinition': 'ml/_types/Analysis.ts#L184-L198', 'ml._types.CategorizationStatus': 'ml/_types/Model.ts#L83-L86', 'ml._types.Category': 'ml/_types/Category.ts#L23-L49', -'ml._types.ChunkingConfig': 'ml/_types/Datafeed.ts#L238-L251', -'ml._types.ChunkingMode': 'ml/_types/Datafeed.ts#L232-L236', +'ml._types.ChunkingConfig': 'ml/_types/Datafeed.ts#L241-L254', +'ml._types.ChunkingMode': 'ml/_types/Datafeed.ts#L235-L239', 'ml._types.ClassificationInferenceOptions': 'ml/_types/inference.ts#L93-L108', 'ml._types.ConditionOperator': 'ml/_types/Rule.ts#L74-L79', 'ml._types.DataCounts': 'ml/_types/Job.ts#L352-L372', 'ml._types.DataDescription': 'ml/_types/Job.ts#L374-L390', -'ml._types.Datafeed': 'ml/_types/Datafeed.ts#L36-L57', +'ml._types.Datafeed': 'ml/_types/Datafeed.ts#L36-L60', 'ml._types.DatafeedAuthorization': 'ml/_types/Authorization.ts#L31-L43', -'ml._types.DatafeedConfig': 'ml/_types/Datafeed.ts#L59-L116', -'ml._types.DatafeedRunningState': 'ml/_types/Datafeed.ts#L197-L211', -'ml._types.DatafeedState': 'ml/_types/Datafeed.ts#L132-L137', -'ml._types.DatafeedStats': 'ml/_types/Datafeed.ts#L139-L168', -'ml._types.DatafeedTimingStats': 'ml/_types/Datafeed.ts#L170-L195', +'ml._types.DatafeedConfig': 'ml/_types/Datafeed.ts#L62-L119', +'ml._types.DatafeedRunningState': 'ml/_types/Datafeed.ts#L200-L214', +'ml._types.DatafeedState': 'ml/_types/Datafeed.ts#L135-L140', +'ml._types.DatafeedStats': 'ml/_types/Datafeed.ts#L142-L171', +'ml._types.DatafeedTimingStats': 'ml/_types/Datafeed.ts#L173-L198', 'ml._types.DataframeAnalysis': 'ml/_types/DataframeAnalytics.ts#L133-L212', 'ml._types.DataframeAnalysisAnalyzedFields': 'ml/_types/DataframeAnalytics.ts#L237-L243', 'ml._types.DataframeAnalysisClassification': 'ml/_types/DataframeAnalytics.ts#L226-L235', @@ -1879,7 +1884,7 @@ 'ml._types.DataframeEvaluationRegressionMetricsHuber': 'ml/_types/DataframeEvaluation.ts#L117-L120', 'ml._types.DataframeEvaluationRegressionMetricsMsle': 'ml/_types/DataframeEvaluation.ts#L112-L115', 'ml._types.DataframeState': 'ml/_types/Dataframe.ts#L20-L26', -'ml._types.DelayedDataCheckConfig': 'ml/_types/Datafeed.ts#L118-L129', +'ml._types.DelayedDataCheckConfig': 'ml/_types/Datafeed.ts#L121-L132', 'ml._types.DeploymentAllocationState': 'ml/_types/TrainedModel.ts#L273-L286', 'ml._types.DeploymentAssignmentState': 'ml/_types/TrainedModel.ts#L288-L305', 'ml._types.DetectionRule': 'ml/_types/Rule.ts#L25-L39', @@ -1933,7 +1938,7 @@ 'ml._types.RoutingState': 'ml/_types/TrainedModel.ts#L347-L368', 'ml._types.RuleAction': 'ml/_types/Rule.ts#L41-L50', 'ml._types.RuleCondition': 'ml/_types/Rule.ts#L52-L65', -'ml._types.RunningStateSearchInterval': 'ml/_types/Datafeed.ts#L213-L230', +'ml._types.RunningStateSearchInterval': 'ml/_types/Datafeed.ts#L216-L233', 'ml._types.SnapshotUpgradeState': 'ml/_types/Model.ts#L94-L99', 'ml._types.TextClassificationInferenceOptions': 'ml/_types/inference.ts#L189-L199', 'ml._types.TextClassificationInferenceUpdateOptions': 'ml/_types/inference.ts#L363-L372', @@ -2310,6 +2315,9 @@ 'query_rules.put_rule.Response': 'query_rules/put_rule/QueryRulePutResponse.ts#L22-L26', 'query_rules.put_ruleset.Request': 'query_rules/put_ruleset/QueryRulesetPutRequest.ts#L23-L43', 'query_rules.put_ruleset.Response': 'query_rules/put_ruleset/QueryRulesetPutResponse.ts#L22-L26', +'query_rules.test.QueryRulesetMatchedRule': 'query_rules/test/QueryRulesetTestResponse.ts#L30-L39', +'query_rules.test.Request': 'query_rules/test/QueryRulesetTestRequest.ts#L24-L44', +'query_rules.test.Response': 'query_rules/test/QueryRulesetTestResponse.ts#L23-L28', 'rollup._types.DateHistogramGrouping': 'rollup/_types/Groupings.ts#L42-L73', 'rollup._types.FieldMetric': 'rollup/_types/Metric.ts#L30-L35', 'rollup._types.Groupings': 'rollup/_types/Groupings.ts#L24-L40', @@ -2409,144 +2417,144 @@ 'security._types.UserProfileHitMetadata': 'security/_types/UserProfile.ts#L27-L30', 'security._types.UserProfileUser': 'security/_types/UserProfile.ts#L32-L39', 'security._types.UserProfileWithMetadata': 'security/_types/UserProfile.ts#L49-L52', -'security.activate_user_profile.Request': 'security/activate_user_profile/Request.ts#L23-L37', +'security.activate_user_profile.Request': 'security/activate_user_profile/Request.ts#L23-L39', 'security.activate_user_profile.Response': 'security/activate_user_profile/Response.ts#L22-L24', -'security.authenticate.Request': 'security/authenticate/SecurityAuthenticateRequest.ts#L22-L32', +'security.authenticate.Request': 'security/authenticate/SecurityAuthenticateRequest.ts#L22-L33', 'security.authenticate.Response': 'security/authenticate/SecurityAuthenticateResponse.ts#L25-L43', 'security.authenticate.Token': 'security/authenticate/types.ts#L22-L29', -'security.bulk_delete_role.Request': 'security/bulk_delete_role/SecurityBulkDeleteRoleRequest.ts#L23-L41', +'security.bulk_delete_role.Request': 'security/bulk_delete_role/SecurityBulkDeleteRoleRequest.ts#L23-L43', 'security.bulk_delete_role.Response': 'security/bulk_delete_role/SecurityBulkDeleteRoleResponse.ts#L22-L37', -'security.bulk_put_role.Request': 'security/bulk_put_role/SecurityBulkPutRoleRequest.ts#L25-L43', +'security.bulk_put_role.Request': 'security/bulk_put_role/SecurityBulkPutRoleRequest.ts#L25-L45', 'security.bulk_put_role.Response': 'security/bulk_put_role/SecurityBulkPutRoleResponse.ts#L22-L41', -'security.change_password.Request': 'security/change_password/SecurityChangePasswordRequest.ts#L23-L51', +'security.change_password.Request': 'security/change_password/SecurityChangePasswordRequest.ts#L23-L54', 'security.change_password.Response': 'security/change_password/SecurityChangePasswordResponse.ts#L20-L22', -'security.clear_api_key_cache.Request': 'security/clear_api_key_cache/SecurityClearApiKeyCacheRequest.ts#L23-L40', +'security.clear_api_key_cache.Request': 'security/clear_api_key_cache/SecurityClearApiKeyCacheRequest.ts#L23-L42', 'security.clear_api_key_cache.Response': 'security/clear_api_key_cache/SecurityClearApiKeyCacheResponse.ts#L25-L32', -'security.clear_cached_privileges.Request': 'security/clear_cached_privileges/SecurityClearCachedPrivilegesRequest.ts#L23-L32', +'security.clear_cached_privileges.Request': 'security/clear_cached_privileges/SecurityClearCachedPrivilegesRequest.ts#L23-L36', 'security.clear_cached_privileges.Response': 'security/clear_cached_privileges/SecurityClearCachedPrivilegesResponse.ts#L25-L32', -'security.clear_cached_realms.Request': 'security/clear_cached_realms/SecurityClearCachedRealmsRequest.ts#L23-L35', +'security.clear_cached_realms.Request': 'security/clear_cached_realms/SecurityClearCachedRealmsRequest.ts#L23-L38', 'security.clear_cached_realms.Response': 'security/clear_cached_realms/SecurityClearCachedRealmsResponse.ts#L25-L32', -'security.clear_cached_roles.Request': 'security/clear_cached_roles/ClearCachedRolesRequest.ts#L23-L32', +'security.clear_cached_roles.Request': 'security/clear_cached_roles/ClearCachedRolesRequest.ts#L23-L35', 'security.clear_cached_roles.Response': 'security/clear_cached_roles/ClearCachedRolesResponse.ts#L25-L32', -'security.clear_cached_service_tokens.Request': 'security/clear_cached_service_tokens/ClearCachedServiceTokensRequest.ts#L23-L34', +'security.clear_cached_service_tokens.Request': 'security/clear_cached_service_tokens/ClearCachedServiceTokensRequest.ts#L23-L38', 'security.clear_cached_service_tokens.Response': 'security/clear_cached_service_tokens/ClearCachedServiceTokensResponse.ts#L25-L32', -'security.create_api_key.Request': 'security/create_api_key/SecurityCreateApiKeyRequest.ts#L26-L59', +'security.create_api_key.Request': 'security/create_api_key/SecurityCreateApiKeyRequest.ts#L26-L60', 'security.create_api_key.Response': 'security/create_api_key/SecurityCreateApiKeyResponse.ts#L23-L50', -'security.create_service_token.Request': 'security/create_service_token/CreateServiceTokenRequest.ts#L23-L38', +'security.create_service_token.Request': 'security/create_service_token/CreateServiceTokenRequest.ts#L23-L41', 'security.create_service_token.Response': 'security/create_service_token/CreateServiceTokenResponse.ts#L22-L27', 'security.create_service_token.Token': 'security/create_service_token/types.ts#L22-L25', 'security.delete_privileges.FoundStatus': 'security/delete_privileges/types.ts#L20-L22', -'security.delete_privileges.Request': 'security/delete_privileges/SecurityDeletePrivilegesRequest.ts#L23-L36', +'security.delete_privileges.Request': 'security/delete_privileges/SecurityDeletePrivilegesRequest.ts#L23-L38', 'security.delete_privileges.Response': 'security/delete_privileges/SecurityDeletePrivilegesResponse.ts#L23-L26', -'security.delete_role.Request': 'security/delete_role/SecurityDeleteRoleRequest.ts#L23-L35', +'security.delete_role.Request': 'security/delete_role/SecurityDeleteRoleRequest.ts#L23-L38', 'security.delete_role.Response': 'security/delete_role/SecurityDeleteRoleResponse.ts#L20-L22', -'security.delete_role_mapping.Request': 'security/delete_role_mapping/SecurityDeleteRoleMappingRequest.ts#L23-L35', +'security.delete_role_mapping.Request': 'security/delete_role_mapping/SecurityDeleteRoleMappingRequest.ts#L23-L36', 'security.delete_role_mapping.Response': 'security/delete_role_mapping/SecurityDeleteRoleMappingResponse.ts#L20-L22', -'security.delete_service_token.Request': 'security/delete_service_token/DeleteServiceTokenRequest.ts#L23-L37', +'security.delete_service_token.Request': 'security/delete_service_token/DeleteServiceTokenRequest.ts#L23-L41', 'security.delete_service_token.Response': 'security/delete_service_token/DeleteServiceTokenResponse.ts#L20-L22', -'security.delete_user.Request': 'security/delete_user/SecurityDeleteUserRequest.ts#L23-L34', +'security.delete_user.Request': 'security/delete_user/SecurityDeleteUserRequest.ts#L23-L37', 'security.delete_user.Response': 'security/delete_user/SecurityDeleteUserResponse.ts#L20-L22', -'security.disable_user.Request': 'security/disable_user/SecurityDisableUserRequest.ts#L23-L34', +'security.disable_user.Request': 'security/disable_user/SecurityDisableUserRequest.ts#L23-L37', 'security.disable_user.Response': 'security/disable_user/SecurityDisableUserResponse.ts#L20-L22', -'security.disable_user_profile.Request': 'security/disable_user_profile/Request.ts#L24-L47', +'security.disable_user_profile.Request': 'security/disable_user_profile/Request.ts#L24-L49', 'security.disable_user_profile.Response': 'security/disable_user_profile/Response.ts#L22-L24', -'security.enable_user.Request': 'security/enable_user/SecurityEnableUserRequest.ts#L23-L34', +'security.enable_user.Request': 'security/enable_user/SecurityEnableUserRequest.ts#L23-L37', 'security.enable_user.Response': 'security/enable_user/SecurityEnableUserResponse.ts#L20-L22', -'security.enable_user_profile.Request': 'security/enable_user_profile/Request.ts#L24-L47', +'security.enable_user_profile.Request': 'security/enable_user_profile/Request.ts#L24-L49', 'security.enable_user_profile.Response': 'security/enable_user_profile/Response.ts#L22-L24', -'security.enroll_kibana.Request': 'security/enroll_kibana/Request.ts#L22-L27', +'security.enroll_kibana.Request': 'security/enroll_kibana/Request.ts#L22-L29', 'security.enroll_kibana.Response': 'security/enroll_kibana/Response.ts#L20-L25', 'security.enroll_kibana.Token': 'security/enroll_kibana/Response.ts#L27-L30', -'security.enroll_node.Request': 'security/enroll_node/Request.ts#L22-L27', +'security.enroll_node.Request': 'security/enroll_node/Request.ts#L22-L29', 'security.enroll_node.Response': 'security/enroll_node/Response.ts#L20-L29', -'security.get_api_key.Request': 'security/get_api_key/SecurityGetApiKeyRequest.ts#L23-L87', +'security.get_api_key.Request': 'security/get_api_key/SecurityGetApiKeyRequest.ts#L23-L88', 'security.get_api_key.Response': 'security/get_api_key/SecurityGetApiKeyResponse.ts#L22-L24', -'security.get_builtin_privileges.Request': 'security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts#L22-L28', +'security.get_builtin_privileges.Request': 'security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts#L22-L32', 'security.get_builtin_privileges.Response': 'security/get_builtin_privileges/SecurityGetBuiltinPrivilegesResponse.ts#L22-L24', -'security.get_privileges.Request': 'security/get_privileges/SecurityGetPrivilegesRequest.ts#L23-L33', +'security.get_privileges.Request': 'security/get_privileges/SecurityGetPrivilegesRequest.ts#L23-L35', 'security.get_privileges.Response': 'security/get_privileges/SecurityGetPrivilegesResponse.ts#L23-L26', -'security.get_role.Request': 'security/get_role/SecurityGetRoleRequest.ts#L23-L38', +'security.get_role.Request': 'security/get_role/SecurityGetRoleRequest.ts#L23-L41', 'security.get_role.Response': 'security/get_role/SecurityGetRoleResponse.ts#L23-L26', 'security.get_role.Role': 'security/get_role/types.ts#L29-L42', -'security.get_role_mapping.Request': 'security/get_role_mapping/SecurityGetRoleMappingRequest.ts#L23-L36', +'security.get_role_mapping.Request': 'security/get_role_mapping/SecurityGetRoleMappingRequest.ts#L23-L42', 'security.get_role_mapping.Response': 'security/get_role_mapping/SecurityGetRoleMappingResponse.ts#L23-L26', -'security.get_service_accounts.Request': 'security/get_service_accounts/GetServiceAccountsRequest.ts#L23-L41', +'security.get_service_accounts.Request': 'security/get_service_accounts/GetServiceAccountsRequest.ts#L23-L44', 'security.get_service_accounts.Response': 'security/get_service_accounts/GetServiceAccountsResponse.ts#L23-L26', 'security.get_service_accounts.RoleDescriptorWrapper': 'security/get_service_accounts/types.ts#L22-L24', 'security.get_service_credentials.NodesCredentials': 'security/get_service_credentials/types.ts#L23-L28', 'security.get_service_credentials.NodesCredentialsFileToken': 'security/get_service_credentials/types.ts#L30-L32', -'security.get_service_credentials.Request': 'security/get_service_credentials/GetServiceCredentialsRequest.ts#L23-L39', +'security.get_service_credentials.Request': 'security/get_service_credentials/GetServiceCredentialsRequest.ts#L23-L41', 'security.get_service_credentials.Response': 'security/get_service_credentials/GetServiceCredentialsResponse.ts#L25-L33', 'security.get_token.AccessTokenGrantType': 'security/get_token/types.ts#L23-L28', 'security.get_token.AuthenticatedUser': 'security/get_token/types.ts#L40-L45', 'security.get_token.AuthenticationProvider': 'security/get_token/types.ts#L35-L38', -'security.get_token.Request': 'security/get_token/GetUserAccessTokenRequest.ts#L25-L39', +'security.get_token.Request': 'security/get_token/GetUserAccessTokenRequest.ts#L25-L42', 'security.get_token.Response': 'security/get_token/GetUserAccessTokenResponse.ts#L23-L33', 'security.get_token.UserRealm': 'security/get_token/types.ts#L30-L33', -'security.get_user.Request': 'security/get_user/SecurityGetUserRequest.ts#L23-L41', +'security.get_user.Request': 'security/get_user/SecurityGetUserRequest.ts#L23-L44', 'security.get_user.Response': 'security/get_user/SecurityGetUserResponse.ts#L23-L26', -'security.get_user_privileges.Request': 'security/get_user_privileges/SecurityGetUserPrivilegesRequest.ts#L23-L36', +'security.get_user_privileges.Request': 'security/get_user_privileges/SecurityGetUserPrivilegesRequest.ts#L23-L37', 'security.get_user_privileges.Response': 'security/get_user_privileges/SecurityGetUserPrivilegesResponse.ts#L26-L34', 'security.get_user_profile.GetUserProfileErrors': 'security/get_user_profile/types.ts#L25-L28', -'security.get_user_profile.Request': 'security/get_user_profile/Request.ts#L23-L46', +'security.get_user_profile.Request': 'security/get_user_profile/Request.ts#L23-L48', 'security.get_user_profile.Response': 'security/get_user_profile/Response.ts#L23-L28', 'security.grant_api_key.ApiKeyGrantType': 'security/grant_api_key/types.ts#L48-L51', 'security.grant_api_key.GrantApiKey': 'security/grant_api_key/types.ts#L25-L46', -'security.grant_api_key.Request': 'security/grant_api_key/SecurityGrantApiKeyRequest.ts#L24-L75', +'security.grant_api_key.Request': 'security/grant_api_key/SecurityGrantApiKeyRequest.ts#L24-L77', 'security.grant_api_key.Response': 'security/grant_api_key/SecurityGrantApiKeyResponse.ts#L23-L31', 'security.has_privileges.ApplicationPrivilegesCheck': 'security/has_privileges/types.ts#L24-L31', 'security.has_privileges.IndexPrivilegesCheck': 'security/has_privileges/types.ts#L33-L44', -'security.has_privileges.Request': 'security/has_privileges/SecurityHasPrivilegesRequest.ts#L25-L44', +'security.has_privileges.Request': 'security/has_privileges/SecurityHasPrivilegesRequest.ts#L25-L46', 'security.has_privileges.Response': 'security/has_privileges/SecurityHasPrivilegesResponse.ts#L24-L32', 'security.has_privileges_user_profile.HasPrivilegesUserProfileErrors': 'security/has_privileges_user_profile/types.ts#L39-L42', 'security.has_privileges_user_profile.PrivilegesCheck': 'security/has_privileges_user_profile/types.ts#L30-L37', -'security.has_privileges_user_profile.Request': 'security/has_privileges_user_profile/Request.ts#L24-L38', +'security.has_privileges_user_profile.Request': 'security/has_privileges_user_profile/Request.ts#L24-L42', 'security.has_privileges_user_profile.Response': 'security/has_privileges_user_profile/Response.ts#L23-L38', -'security.invalidate_api_key.Request': 'security/invalidate_api_key/SecurityInvalidateApiKeyRequest.ts#L23-L67', +'security.invalidate_api_key.Request': 'security/invalidate_api_key/SecurityInvalidateApiKeyRequest.ts#L23-L69', 'security.invalidate_api_key.Response': 'security/invalidate_api_key/SecurityInvalidateApiKeyResponse.ts#L23-L30', -'security.invalidate_token.Request': 'security/invalidate_token/SecurityInvalidateTokenRequest.ts#L23-L35', +'security.invalidate_token.Request': 'security/invalidate_token/SecurityInvalidateTokenRequest.ts#L23-L43', 'security.invalidate_token.Response': 'security/invalidate_token/SecurityInvalidateTokenResponse.ts#L23-L30', 'security.put_privileges.Actions': 'security/put_privileges/types.ts#L22-L27', -'security.put_privileges.Request': 'security/put_privileges/SecurityPutPrivilegesRequest.ts#L25-L37', +'security.put_privileges.Request': 'security/put_privileges/SecurityPutPrivilegesRequest.ts#L25-L38', 'security.put_privileges.Response': 'security/put_privileges/SecurityPutPrivilegesResponse.ts#L23-L26', -'security.put_role.Request': 'security/put_role/SecurityPutRoleRequest.ts#L31-L91', +'security.put_role.Request': 'security/put_role/SecurityPutRoleRequest.ts#L31-L95', 'security.put_role.Response': 'security/put_role/SecurityPutRoleResponse.ts#L22-L24', -'security.put_role_mapping.Request': 'security/put_role_mapping/SecurityPutRoleMappingRequest.ts#L25-L47', +'security.put_role_mapping.Request': 'security/put_role_mapping/SecurityPutRoleMappingRequest.ts#L25-L56', 'security.put_role_mapping.Response': 'security/put_role_mapping/SecurityPutRoleMappingResponse.ts#L22-L24', -'security.put_user.Request': 'security/put_user/SecurityPutUserRequest.ts#L23-L44', +'security.put_user.Request': 'security/put_user/SecurityPutUserRequest.ts#L23-L48', 'security.put_user.Response': 'security/put_user/SecurityPutUserResponse.ts#L20-L22', 'security.query_api_keys.ApiKeyAggregate': 'security/query_api_keys/types.ts#L122-L139', 'security.query_api_keys.ApiKeyAggregationContainer': 'security/query_api_keys/types.ts#L63-L120', 'security.query_api_keys.ApiKeyFiltersAggregation': 'security/query_api_keys/types.ts#L207-L227', 'security.query_api_keys.ApiKeyQueryContainer': 'security/query_api_keys/types.ts#L141-L205', -'security.query_api_keys.Request': 'security/query_api_keys/QueryApiKeysRequest.ts#L26-L100', +'security.query_api_keys.Request': 'security/query_api_keys/QueryApiKeysRequest.ts#L26-L101', 'security.query_api_keys.Response': 'security/query_api_keys/QueryApiKeysResponse.ts#L26-L45', 'security.query_role.QueryRole': 'security/query_role/types.ts#L103-L109', -'security.query_role.Request': 'security/query_role/QueryRolesRequest.ts#L25-L67', +'security.query_role.Request': 'security/query_role/QueryRolesRequest.ts#L25-L69', 'security.query_role.Response': 'security/query_role/QueryRolesResponse.ts#L23-L38', 'security.query_role.RoleQueryContainer': 'security/query_role/types.ts#L37-L101', 'security.query_user.QueryUser': 'security/query_user/types.ts#L103-L105', -'security.query_user.Request': 'security/query_user/SecurityQueryUserRequest.ts#L25-L72', +'security.query_user.Request': 'security/query_user/SecurityQueryUserRequest.ts#L25-L75', 'security.query_user.Response': 'security/query_user/SecurityQueryUserResponse.ts#L23-L38', 'security.query_user.UserQueryContainer': 'security/query_user/types.ts#L37-L101', -'security.saml_authenticate.Request': 'security/saml_authenticate/Request.ts#L23-L38', +'security.saml_authenticate.Request': 'security/saml_authenticate/Request.ts#L23-L40', 'security.saml_authenticate.Response': 'security/saml_authenticate/Response.ts#L22-L30', -'security.saml_complete_logout.Request': 'security/saml_complete_logout/Request.ts#L23-L40', -'security.saml_invalidate.Request': 'security/saml_invalidate/Request.ts#L22-L43', +'security.saml_complete_logout.Request': 'security/saml_complete_logout/Request.ts#L23-L42', +'security.saml_invalidate.Request': 'security/saml_invalidate/Request.ts#L22-L45', 'security.saml_invalidate.Response': 'security/saml_invalidate/Response.ts#L22-L28', -'security.saml_logout.Request': 'security/saml_logout/Request.ts#L22-L41', +'security.saml_logout.Request': 'security/saml_logout/Request.ts#L22-L43', 'security.saml_logout.Response': 'security/saml_logout/Response.ts#L20-L24', -'security.saml_prepare_authentication.Request': 'security/saml_prepare_authentication/Request.ts#L22-L46', +'security.saml_prepare_authentication.Request': 'security/saml_prepare_authentication/Request.ts#L22-L48', 'security.saml_prepare_authentication.Response': 'security/saml_prepare_authentication/Response.ts#L22-L28', -'security.saml_service_provider_metadata.Request': 'security/saml_service_provider_metadata/Request.ts#L23-L34', +'security.saml_service_provider_metadata.Request': 'security/saml_service_provider_metadata/Request.ts#L23-L36', 'security.saml_service_provider_metadata.Response': 'security/saml_service_provider_metadata/Response.ts#L20-L24', 'security.suggest_user_profiles.Hint': 'security/suggest_user_profiles/types.ts#L23-L34', -'security.suggest_user_profiles.Request': 'security/suggest_user_profiles/Request.ts#L24-L66', +'security.suggest_user_profiles.Request': 'security/suggest_user_profiles/Request.ts#L24-L68', 'security.suggest_user_profiles.Response': 'security/suggest_user_profiles/Response.ts#L29-L35', 'security.suggest_user_profiles.TotalUserProfiles': 'security/suggest_user_profiles/Response.ts#L24-L27', -'security.update_api_key.Request': 'security/update_api_key/Request.ts#L26-L66', +'security.update_api_key.Request': 'security/update_api_key/Request.ts#L26-L67', 'security.update_api_key.Response': 'security/update_api_key/Response.ts#L20-L28', -'security.update_user_profile_data.Request': 'security/update_user_profile_data/Request.ts#L27-L70', +'security.update_user_profile_data.Request': 'security/update_user_profile_data/Request.ts#L27-L72', 'security.update_user_profile_data.Response': 'security/update_user_profile_data/Response.ts#L22-L24', 'shutdown._types.Type': 'shutdown/_types/types.ts#L20-L24', 'shutdown.delete_node.Request': 'shutdown/delete_node/ShutdownDeleteNodeRequest.ts#L24-L44', @@ -2658,7 +2666,7 @@ 'sql.translate.Request': 'sql/translate/TranslateSqlRequest.ts#L25-L54', 'sql.translate.Response': 'sql/translate/TranslateSqlResponse.ts#L27-L37', 'ssl.certificates.CertificateInformation': 'ssl/certificates/types.ts#L22-L31', -'ssl.certificates.Request': 'ssl/certificates/GetCertificatesRequest.ts#L22-L27', +'ssl.certificates.Request': 'ssl/certificates/GetCertificatesRequest.ts#L22-L45', 'ssl.certificates.Response': 'ssl/certificates/GetCertificatesResponse.ts#L22-L24', 'synonyms._types.SynonymRule': 'synonyms/_types/SynonymRule.ts#L26-L35', 'synonyms._types.SynonymRuleRead': 'synonyms/_types/SynonymRule.ts#L38-L47', @@ -2932,10 +2940,10 @@ if (hash.length > 1) { hash = hash.substring(1); } - window.location = "https://github.com/elastic/elasticsearch-specification/tree/128eca805077b017729da800bc201acae5b86311/specification/" + (paths[hash] || ""); + window.location = "https://github.com/elastic/elasticsearch-specification/tree/c324fbab4644a938ec8b8c420dbe219ab2b44348/specification/" + (paths[hash] || ""); </script> </head> <body> - Please see the <a href="https://github.com/elastic/elasticsearch-specification/tree/128eca805077b017729da800bc201acae5b86311/specification/">Elasticsearch API specification</a>. + Please see the <a href="https://github.com/elastic/elasticsearch-specification/tree/c324fbab4644a938ec8b8c420dbe219ab2b44348/specification/">Elasticsearch API specification</a>. </body> </html> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/enrich/ElasticsearchEnrichAsyncClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/enrich/ElasticsearchEnrichAsyncClient.java index 4c9bdce32..36ebf5280 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/enrich/ElasticsearchEnrichAsyncClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/enrich/ElasticsearchEnrichAsyncClient.java @@ -106,7 +106,7 @@ public final CompletableFuture<DeletePolicyResponse> deletePolicy( * Creates the enrich index for an existing enrich policy. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/execute-enrich-policy-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/execute-enrich-policy-api.html">Documentation * on elastic.co</a> */ @@ -124,7 +124,7 @@ public CompletableFuture<ExecutePolicyResponse> executePolicy(ExecutePolicyReque * a function that initializes a builder to create the * {@link ExecutePolicyRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/execute-enrich-policy-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/execute-enrich-policy-api.html">Documentation * on elastic.co</a> */ @@ -185,7 +185,7 @@ public CompletableFuture<GetPolicyResponse> getPolicy() { * Create an enrich policy. Creates an enrich policy. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/put-enrich-policy-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-enrich-policy-api.html">Documentation * on elastic.co</a> */ @@ -203,7 +203,7 @@ public CompletableFuture<PutPolicyResponse> putPolicy(PutPolicyRequest request) * a function that initializes a builder to create the * {@link PutPolicyRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/put-enrich-policy-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-enrich-policy-api.html">Documentation * on elastic.co</a> */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/enrich/ElasticsearchEnrichClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/enrich/ElasticsearchEnrichClient.java index 2307719b0..b29aad331 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/enrich/ElasticsearchEnrichClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/enrich/ElasticsearchEnrichClient.java @@ -107,7 +107,7 @@ public final DeletePolicyResponse deletePolicy( * Creates the enrich index for an existing enrich policy. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/execute-enrich-policy-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/execute-enrich-policy-api.html">Documentation * on elastic.co</a> */ @@ -126,7 +126,7 @@ public ExecutePolicyResponse executePolicy(ExecutePolicyRequest request) * a function that initializes a builder to create the * {@link ExecutePolicyRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/execute-enrich-policy-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/execute-enrich-policy-api.html">Documentation * on elastic.co</a> */ @@ -188,7 +188,7 @@ public GetPolicyResponse getPolicy() throws IOException, ElasticsearchException * Create an enrich policy. Creates an enrich policy. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/put-enrich-policy-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-enrich-policy-api.html">Documentation * on elastic.co</a> */ @@ -206,7 +206,7 @@ public PutPolicyResponse putPolicy(PutPolicyRequest request) throws IOException, * a function that initializes a builder to create the * {@link PutPolicyRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/put-enrich-policy-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-enrich-policy-api.html">Documentation * on elastic.co</a> */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/eql/ElasticsearchEqlAsyncClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/eql/ElasticsearchEqlAsyncClient.java index 93124a899..945ba4ed1 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/eql/ElasticsearchEqlAsyncClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/eql/ElasticsearchEqlAsyncClient.java @@ -108,7 +108,7 @@ public final CompletableFuture<EqlDeleteResponse> delete( * stored synchronous EQL search. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-async-eql-search-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-async-eql-search-api.html">Documentation * on elastic.co</a> */ @@ -129,7 +129,7 @@ public <TEvent> CompletableFuture<EqlGetResponse<TEvent>> get(EqlGetRequest requ * a function that initializes a builder to create the * {@link EqlGetRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-async-eql-search-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-async-eql-search-api.html">Documentation * on elastic.co</a> */ @@ -143,7 +143,7 @@ public final <TEvent> CompletableFuture<EqlGetResponse<TEvent>> get( * stored synchronous EQL search. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-async-eql-search-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-async-eql-search-api.html">Documentation * on elastic.co</a> */ @@ -164,7 +164,7 @@ public <TEvent> CompletableFuture<EqlGetResponse<TEvent>> get(EqlGetRequest requ * a function that initializes a builder to create the * {@link EqlGetRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-async-eql-search-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-async-eql-search-api.html">Documentation * on elastic.co</a> */ @@ -180,7 +180,7 @@ public final <TEvent> CompletableFuture<EqlGetResponse<TEvent>> get( * EQL search without returning results. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-async-eql-status-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-async-eql-status-api.html">Documentation * on elastic.co</a> */ @@ -199,7 +199,7 @@ public CompletableFuture<GetEqlStatusResponse> getStatus(GetEqlStatusRequest req * a function that initializes a builder to create the * {@link GetEqlStatusRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-async-eql-status-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-async-eql-status-api.html">Documentation * on elastic.co</a> */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/eql/ElasticsearchEqlClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/eql/ElasticsearchEqlClient.java index 32a736936..2d6c3f7cc 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/eql/ElasticsearchEqlClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/eql/ElasticsearchEqlClient.java @@ -109,7 +109,7 @@ public final EqlDeleteResponse delete(Function<EqlDeleteRequest.Builder, ObjectB * stored synchronous EQL search. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-async-eql-search-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-async-eql-search-api.html">Documentation * on elastic.co</a> */ @@ -131,7 +131,7 @@ public <TEvent> EqlGetResponse<TEvent> get(EqlGetRequest request, Class<TEvent> * a function that initializes a builder to create the * {@link EqlGetRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-async-eql-search-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-async-eql-search-api.html">Documentation * on elastic.co</a> */ @@ -145,7 +145,7 @@ public final <TEvent> EqlGetResponse<TEvent> get(Function<EqlGetRequest.Builder, * stored synchronous EQL search. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-async-eql-search-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-async-eql-search-api.html">Documentation * on elastic.co</a> */ @@ -167,7 +167,7 @@ public <TEvent> EqlGetResponse<TEvent> get(EqlGetRequest request, Type tEventTyp * a function that initializes a builder to create the * {@link EqlGetRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-async-eql-search-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-async-eql-search-api.html">Documentation * on elastic.co</a> */ @@ -183,7 +183,7 @@ public final <TEvent> EqlGetResponse<TEvent> get(Function<EqlGetRequest.Builder, * EQL search without returning results. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-async-eql-status-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-async-eql-status-api.html">Documentation * on elastic.co</a> */ @@ -202,7 +202,7 @@ public GetEqlStatusResponse getStatus(GetEqlStatusRequest request) throws IOExce * a function that initializes a builder to create the * {@link GetEqlStatusRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-async-eql-status-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-async-eql-status-api.html">Documentation * on elastic.co</a> */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/esql/ElasticsearchEsqlAsyncClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/esql/ElasticsearchEsqlAsyncClient.java index 7da689e95..905b168b9 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/esql/ElasticsearchEsqlAsyncClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/esql/ElasticsearchEsqlAsyncClient.java @@ -73,7 +73,7 @@ public ElasticsearchEsqlAsyncClient withTransportOptions(@Nullable TransportOpti * Executes an ES|QL request * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/esql-rest.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/esql-rest.html">Documentation * on elastic.co</a> */ @@ -91,7 +91,7 @@ public CompletableFuture<BinaryResponse> query(QueryRequest request) { * a function that initializes a builder to create the * {@link QueryRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/esql-rest.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/esql-rest.html">Documentation * on elastic.co</a> */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/esql/ElasticsearchEsqlClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/esql/ElasticsearchEsqlClient.java index c24b5f683..c3858dc2f 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/esql/ElasticsearchEsqlClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/esql/ElasticsearchEsqlClient.java @@ -74,7 +74,7 @@ public ElasticsearchEsqlClient withTransportOptions(@Nullable TransportOptions t * Executes an ES|QL request * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/esql-rest.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/esql-rest.html">Documentation * on elastic.co</a> */ @@ -92,7 +92,7 @@ public BinaryResponse query(QueryRequest request) throws IOException, Elasticsea * a function that initializes a builder to create the * {@link QueryRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/esql-rest.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/esql-rest.html">Documentation * on elastic.co</a> */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/graph/ElasticsearchGraphAsyncClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/graph/ElasticsearchGraphAsyncClient.java index 18ec23f16..19c7ffdb2 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/graph/ElasticsearchGraphAsyncClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/graph/ElasticsearchGraphAsyncClient.java @@ -72,7 +72,7 @@ public ElasticsearchGraphAsyncClient withTransportOptions(@Nullable TransportOpt * Elasticsearch data stream or index. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/graph-explore-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/graph-explore-api.html">Documentation * on elastic.co</a> */ @@ -91,7 +91,7 @@ public CompletableFuture<ExploreResponse> explore(ExploreRequest request) { * a function that initializes a builder to create the * {@link ExploreRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/graph-explore-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/graph-explore-api.html">Documentation * on elastic.co</a> */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/graph/ElasticsearchGraphClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/graph/ElasticsearchGraphClient.java index 6d254eddd..1eaf5a8f7 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/graph/ElasticsearchGraphClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/graph/ElasticsearchGraphClient.java @@ -72,7 +72,7 @@ public ElasticsearchGraphClient withTransportOptions(@Nullable TransportOptions * Elasticsearch data stream or index. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/graph-explore-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/graph-explore-api.html">Documentation * on elastic.co</a> */ @@ -91,7 +91,7 @@ public ExploreResponse explore(ExploreRequest request) throws IOException, Elast * a function that initializes a builder to create the * {@link ExploreRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/graph-explore-api.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/graph-explore-api.html">Documentation * on elastic.co</a> */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/indices/AnalyzeRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/indices/AnalyzeRequest.java index a53cc84ad..f25407a11 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/indices/AnalyzeRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/indices/AnalyzeRequest.java @@ -63,7 +63,9 @@ // typedef: indices.analyze.Request /** - * Performs analysis on a text string and returns the resulting tokens. + * Get tokens from text analysis. The analyze API performs <a href= + * "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html">analysis</a> + * on a text string and returns the resulting tokens. * * @see <a href="../doc-files/api-spec.html#indices.analyze.Request">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/indices/ElasticsearchIndicesAsyncClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/indices/ElasticsearchIndicesAsyncClient.java index 212ac9ac3..e7168bd24 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/indices/ElasticsearchIndicesAsyncClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/indices/ElasticsearchIndicesAsyncClient.java @@ -106,10 +106,12 @@ public final CompletableFuture<AddBlockResponse> addBlock( // ----- Endpoint: indices.analyze /** - * Performs analysis on a text string and returns the resulting tokens. + * Get tokens from text analysis. The analyze API performs <a href= + * "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html">analysis</a> + * on a text string and returns the resulting tokens. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-analyze.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-analyze.html">Documentation * on elastic.co</a> */ @@ -121,13 +123,15 @@ public CompletableFuture<AnalyzeResponse> analyze(AnalyzeRequest request) { } /** - * Performs analysis on a text string and returns the resulting tokens. + * Get tokens from text analysis. The analyze API performs <a href= + * "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html">analysis</a> + * on a text string and returns the resulting tokens. * * @param fn * a function that initializes a builder to create the * {@link AnalyzeRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-analyze.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-analyze.html">Documentation * on elastic.co</a> */ @@ -137,10 +141,12 @@ public final CompletableFuture<AnalyzeResponse> analyze( } /** - * Performs analysis on a text string and returns the resulting tokens. + * Get tokens from text analysis. The analyze API performs <a href= + * "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html">analysis</a> + * on a text string and returns the resulting tokens. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-analyze.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-analyze.html">Documentation * on elastic.co</a> */ @@ -237,7 +243,7 @@ public final CompletableFuture<CloneIndexResponse> clone( * Closes an index. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-close.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-close.html">Documentation * on elastic.co</a> */ @@ -255,7 +261,7 @@ public CompletableFuture<CloseIndexResponse> close(CloseIndexRequest request) { * a function that initializes a builder to create the * {@link CloseIndexRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-close.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-close.html">Documentation * on elastic.co</a> */ @@ -270,7 +276,7 @@ public final CompletableFuture<CloseIndexResponse> close( * Create an index. Creates a new index. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-create-index.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-create-index.html">Documentation * on elastic.co</a> */ @@ -288,7 +294,7 @@ public CompletableFuture<CreateIndexResponse> create(CreateIndexRequest request) * a function that initializes a builder to create the * {@link CreateIndexRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-create-index.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-create-index.html">Documentation * on elastic.co</a> */ @@ -592,7 +598,7 @@ public final CompletableFuture<DeleteTemplateResponse> deleteTemplate( * Analyzes the disk usage of each field of an index or data stream. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-disk-usage.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-disk-usage.html">Documentation * on elastic.co</a> */ @@ -610,7 +616,7 @@ public CompletableFuture<DiskUsageResponse> diskUsage(DiskUsageRequest request) * a function that initializes a builder to create the * {@link DiskUsageRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-disk-usage.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-disk-usage.html">Documentation * on elastic.co</a> */ @@ -628,7 +634,7 @@ public final CompletableFuture<DiskUsageResponse> diskUsage( * by a configured time interval. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-downsample-data-stream.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-downsample-data-stream.html">Documentation * on elastic.co</a> */ @@ -649,7 +655,7 @@ public CompletableFuture<DownsampleResponse> downsample(DownsampleRequest reques * a function that initializes a builder to create the * {@link DownsampleRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-downsample-data-stream.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-downsample-data-stream.html">Documentation * on elastic.co</a> */ @@ -872,7 +878,7 @@ public final CompletableFuture<FieldUsageStatsResponse> fieldUsageStats( * Flushes one or more data streams or indices. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-flush.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-flush.html">Documentation * on elastic.co</a> */ @@ -890,7 +896,7 @@ public CompletableFuture<FlushResponse> flush(FlushRequest request) { * a function that initializes a builder to create the * {@link FlushRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-flush.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-flush.html">Documentation * on elastic.co</a> */ @@ -903,7 +909,7 @@ public final CompletableFuture<FlushResponse> flush( * Flushes one or more data streams or indices. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-flush.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-flush.html">Documentation * on elastic.co</a> */ @@ -1949,7 +1955,7 @@ public final CompletableFuture<ResolveIndexResponse> resolveIndex( * alias. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-rollover-index.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-rollover-index.html">Documentation * on elastic.co</a> */ @@ -1968,7 +1974,7 @@ public CompletableFuture<RolloverResponse> rollover(RolloverRequest request) { * a function that initializes a builder to create the * {@link RolloverRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-rollover-index.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-rollover-index.html">Documentation * on elastic.co</a> */ @@ -2084,7 +2090,7 @@ public CompletableFuture<ShardStoresResponse> shardStores() { * Shrinks an existing index into a new index with fewer primary shards. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-shrink-index.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-shrink-index.html">Documentation * on elastic.co</a> */ @@ -2102,7 +2108,7 @@ public CompletableFuture<ShrinkResponse> shrink(ShrinkRequest request) { * a function that initializes a builder to create the * {@link ShrinkRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-shrink-index.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-shrink-index.html">Documentation * on elastic.co</a> */ @@ -2202,7 +2208,7 @@ public CompletableFuture<SimulateTemplateResponse> simulateTemplate() { * Splits an existing index into a new index with more primary shards. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-split-index.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-split-index.html">Documentation * on elastic.co</a> */ @@ -2220,7 +2226,7 @@ public CompletableFuture<SplitResponse> split(SplitRequest request) { * a function that initializes a builder to create the * {@link SplitRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-split-index.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-split-index.html">Documentation * on elastic.co</a> */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/indices/ElasticsearchIndicesClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/indices/ElasticsearchIndicesClient.java index 3fc39aa81..f34fcc15c 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/indices/ElasticsearchIndicesClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/indices/ElasticsearchIndicesClient.java @@ -104,10 +104,12 @@ public final AddBlockResponse addBlock(Function<AddBlockRequest.Builder, ObjectB // ----- Endpoint: indices.analyze /** - * Performs analysis on a text string and returns the resulting tokens. + * Get tokens from text analysis. The analyze API performs <a href= + * "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html">analysis</a> + * on a text string and returns the resulting tokens. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-analyze.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-analyze.html">Documentation * on elastic.co</a> */ @@ -119,13 +121,15 @@ public AnalyzeResponse analyze(AnalyzeRequest request) throws IOException, Elast } /** - * Performs analysis on a text string and returns the resulting tokens. + * Get tokens from text analysis. The analyze API performs <a href= + * "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html">analysis</a> + * on a text string and returns the resulting tokens. * * @param fn * a function that initializes a builder to create the * {@link AnalyzeRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-analyze.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-analyze.html">Documentation * on elastic.co</a> */ @@ -135,10 +139,12 @@ public final AnalyzeResponse analyze(Function<AnalyzeRequest.Builder, ObjectBuil } /** - * Performs analysis on a text string and returns the resulting tokens. + * Get tokens from text analysis. The analyze API performs <a href= + * "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html">analysis</a> + * on a text string and returns the resulting tokens. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-analyze.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-analyze.html">Documentation * on elastic.co</a> */ @@ -235,7 +241,7 @@ public final CloneIndexResponse clone(Function<CloneIndexRequest.Builder, Object * Closes an index. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-close.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-close.html">Documentation * on elastic.co</a> */ @@ -253,7 +259,7 @@ public CloseIndexResponse close(CloseIndexRequest request) throws IOException, E * a function that initializes a builder to create the * {@link CloseIndexRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-close.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-close.html">Documentation * on elastic.co</a> */ @@ -268,7 +274,7 @@ public final CloseIndexResponse close(Function<CloseIndexRequest.Builder, Object * Create an index. Creates a new index. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-create-index.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-create-index.html">Documentation * on elastic.co</a> */ @@ -286,7 +292,7 @@ public CreateIndexResponse create(CreateIndexRequest request) throws IOException * a function that initializes a builder to create the * {@link CreateIndexRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-create-index.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-create-index.html">Documentation * on elastic.co</a> */ @@ -603,7 +609,7 @@ public final DeleteTemplateResponse deleteTemplate( * Analyzes the disk usage of each field of an index or data stream. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-disk-usage.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-disk-usage.html">Documentation * on elastic.co</a> */ @@ -621,7 +627,7 @@ public DiskUsageResponse diskUsage(DiskUsageRequest request) throws IOException, * a function that initializes a builder to create the * {@link DiskUsageRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-disk-usage.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-disk-usage.html">Documentation * on elastic.co</a> */ @@ -639,7 +645,7 @@ public final DiskUsageResponse diskUsage(Function<DiskUsageRequest.Builder, Obje * by a configured time interval. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-downsample-data-stream.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-downsample-data-stream.html">Documentation * on elastic.co</a> */ @@ -660,7 +666,7 @@ public DownsampleResponse downsample(DownsampleRequest request) throws IOExcepti * a function that initializes a builder to create the * {@link DownsampleRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-downsample-data-stream.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-downsample-data-stream.html">Documentation * on elastic.co</a> */ @@ -890,7 +896,7 @@ public final FieldUsageStatsResponse fieldUsageStats( * Flushes one or more data streams or indices. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-flush.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-flush.html">Documentation * on elastic.co</a> */ @@ -908,7 +914,7 @@ public FlushResponse flush(FlushRequest request) throws IOException, Elasticsear * a function that initializes a builder to create the * {@link FlushRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-flush.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-flush.html">Documentation * on elastic.co</a> */ @@ -921,7 +927,7 @@ public final FlushResponse flush(Function<FlushRequest.Builder, ObjectBuilder<Fl * Flushes one or more data streams or indices. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-flush.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-flush.html">Documentation * on elastic.co</a> */ @@ -1996,7 +2002,7 @@ public final ResolveIndexResponse resolveIndex( * alias. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-rollover-index.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-rollover-index.html">Documentation * on elastic.co</a> */ @@ -2015,7 +2021,7 @@ public RolloverResponse rollover(RolloverRequest request) throws IOException, El * a function that initializes a builder to create the * {@link RolloverRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-rollover-index.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-rollover-index.html">Documentation * on elastic.co</a> */ @@ -2132,7 +2138,7 @@ public ShardStoresResponse shardStores() throws IOException, ElasticsearchExcept * Shrinks an existing index into a new index with fewer primary shards. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-shrink-index.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-shrink-index.html">Documentation * on elastic.co</a> */ @@ -2150,7 +2156,7 @@ public ShrinkResponse shrink(ShrinkRequest request) throws IOException, Elastics * a function that initializes a builder to create the * {@link ShrinkRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-shrink-index.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-shrink-index.html">Documentation * on elastic.co</a> */ @@ -2253,7 +2259,7 @@ public SimulateTemplateResponse simulateTemplate() throws IOException, Elasticse * Splits an existing index into a new index with more primary shards. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-split-index.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-split-index.html">Documentation * on elastic.co</a> */ @@ -2271,7 +2277,7 @@ public SplitResponse split(SplitRequest request) throws IOException, Elasticsear * a function that initializes a builder to create the * {@link SplitRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-split-index.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-split-index.html">Documentation * on elastic.co</a> */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/indices/IndexSettings.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/indices/IndexSettings.java index 8f684cc76..9de4bf6f0 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/indices/IndexSettings.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/indices/IndexSettings.java @@ -64,7 +64,7 @@ /** * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/index-modules.html#index-modules-settings">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/index-modules.html#index-modules-settings">Documentation * on elastic.co</a> * @see <a href="../doc-files/api-spec.html#indices._types.IndexSettings">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/indices/MappingLimitSettings.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/indices/MappingLimitSettings.java index cae1bba67..982b0e252 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/indices/MappingLimitSettings.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/indices/MappingLimitSettings.java @@ -55,7 +55,7 @@ * Mapping Limit Settings * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/mapping-settings-limit.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/mapping-settings-limit.html">Documentation * on elastic.co</a> * @see <a href= * "../doc-files/api-spec.html#indices._types.MappingLimitSettings">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/inference/InferenceEndpoint.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/inference/InferenceEndpoint.java index 89d4b95a9..4d134db1f 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/inference/InferenceEndpoint.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/inference/InferenceEndpoint.java @@ -66,6 +66,7 @@ public class InferenceEndpoint implements JsonpSerializable { private final JsonData serviceSettings; + @Nullable private final JsonData taskSettings; // --------------------------------------------------------------------------------------------- @@ -74,7 +75,7 @@ protected InferenceEndpoint(AbstractBuilder<?> builder) { this.service = ApiTypeHelper.requireNonNull(builder.service, this, "service"); this.serviceSettings = ApiTypeHelper.requireNonNull(builder.serviceSettings, this, "serviceSettings"); - this.taskSettings = ApiTypeHelper.requireNonNull(builder.taskSettings, this, "taskSettings"); + this.taskSettings = builder.taskSettings; } @@ -101,10 +102,11 @@ public final JsonData serviceSettings() { } /** - * Required - Task settings specific to the service and task type + * Task settings specific to the service and task type * <p> * API name: {@code task_settings} */ + @Nullable public final JsonData taskSettings() { return this.taskSettings; } @@ -126,8 +128,11 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) { generator.writeKey("service_settings"); this.serviceSettings.serialize(generator, mapper); - generator.writeKey("task_settings"); - this.taskSettings.serialize(generator, mapper); + if (this.taskSettings != null) { + generator.writeKey("task_settings"); + this.taskSettings.serialize(generator, mapper); + + } } @@ -170,6 +175,7 @@ public abstract static class AbstractBuilder<BuilderT extends AbstractBuilder<Bu private JsonData serviceSettings; + @Nullable private JsonData taskSettings; /** @@ -193,11 +199,11 @@ public final BuilderT serviceSettings(JsonData value) { } /** - * Required - Task settings specific to the service and task type + * Task settings specific to the service and task type * <p> * API name: {@code task_settings} */ - public final BuilderT taskSettings(JsonData value) { + public final BuilderT taskSettings(@Nullable JsonData value) { this.taskSettings = value; return self(); } diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/CommunityIDProcessor.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/CommunityIDProcessor.java new file mode 100644 index 000000000..df31bb45c --- /dev/null +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/CommunityIDProcessor.java @@ -0,0 +1,502 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package co.elastic.clients.elasticsearch.ingest; + +import co.elastic.clients.json.JsonpDeserializable; +import co.elastic.clients.json.JsonpDeserializer; +import co.elastic.clients.json.JsonpMapper; +import co.elastic.clients.json.ObjectBuilderDeserializer; +import co.elastic.clients.json.ObjectDeserializer; +import co.elastic.clients.util.ObjectBuilder; +import jakarta.json.stream.JsonGenerator; +import java.lang.Boolean; +import java.lang.Integer; +import java.lang.String; +import java.util.Objects; +import java.util.function.Function; +import javax.annotation.Nullable; + +//---------------------------------------------------------------- +// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST. +//---------------------------------------------------------------- +// +// This code is generated from the Elasticsearch API specification +// at https://github.com/elastic/elasticsearch-specification +// +// Manual updates to this file will be lost when the code is +// re-generated. +// +// If you find a property that is missing or wrongly typed, please +// open an issue or a PR on the API specification repository. +// +//---------------------------------------------------------------- + +// typedef: ingest._types.CommunityIDProcessor + +/** + * + * @see <a href= + * "../doc-files/api-spec.html#ingest._types.CommunityIDProcessor">API + * specification</a> + */ +@JsonpDeserializable +public class CommunityIDProcessor extends ProcessorBase implements ProcessorVariant { + @Nullable + private final String sourceIp; + + @Nullable + private final String sourcePort; + + @Nullable + private final String destinationIp; + + @Nullable + private final String destinationPort; + + @Nullable + private final String ianaNumber; + + @Nullable + private final String icmpType; + + @Nullable + private final String icmpCode; + + @Nullable + private final String transport; + + @Nullable + private final String targetField; + + @Nullable + private final Integer seed; + + @Nullable + private final Boolean ignoreMissing; + + // --------------------------------------------------------------------------------------------- + + private CommunityIDProcessor(Builder builder) { + super(builder); + + this.sourceIp = builder.sourceIp; + this.sourcePort = builder.sourcePort; + this.destinationIp = builder.destinationIp; + this.destinationPort = builder.destinationPort; + this.ianaNumber = builder.ianaNumber; + this.icmpType = builder.icmpType; + this.icmpCode = builder.icmpCode; + this.transport = builder.transport; + this.targetField = builder.targetField; + this.seed = builder.seed; + this.ignoreMissing = builder.ignoreMissing; + + } + + public static CommunityIDProcessor of(Function<Builder, ObjectBuilder<CommunityIDProcessor>> fn) { + return fn.apply(new Builder()).build(); + } + + /** + * Processor variant kind. + */ + @Override + public Processor.Kind _processorKind() { + return Processor.Kind.CommunityId; + } + + /** + * Field containing the source IP address. + * <p> + * API name: {@code source_ip} + */ + @Nullable + public final String sourceIp() { + return this.sourceIp; + } + + /** + * Field containing the source port. + * <p> + * API name: {@code source_port} + */ + @Nullable + public final String sourcePort() { + return this.sourcePort; + } + + /** + * Field containing the destination IP address. + * <p> + * API name: {@code destination_ip} + */ + @Nullable + public final String destinationIp() { + return this.destinationIp; + } + + /** + * Field containing the destination port. + * <p> + * API name: {@code destination_port} + */ + @Nullable + public final String destinationPort() { + return this.destinationPort; + } + + /** + * Field containing the IANA number. + * <p> + * API name: {@code iana_number} + */ + @Nullable + public final String ianaNumber() { + return this.ianaNumber; + } + + /** + * Field containing the ICMP type. + * <p> + * API name: {@code icmp_type} + */ + @Nullable + public final String icmpType() { + return this.icmpType; + } + + /** + * Field containing the ICMP code. + * <p> + * API name: {@code icmp_code} + */ + @Nullable + public final String icmpCode() { + return this.icmpCode; + } + + /** + * Field containing the transport protocol name or number. Used only when the + * iana_number field is not present. The following protocol names are currently + * supported: eigrp, gre, icmp, icmpv6, igmp, ipv6-icmp, ospf, pim, sctp, tcp, + * udp + * <p> + * API name: {@code transport} + */ + @Nullable + public final String transport() { + return this.transport; + } + + /** + * Output field for the community ID. + * <p> + * API name: {@code target_field} + */ + @Nullable + public final String targetField() { + return this.targetField; + } + + /** + * Seed for the community ID hash. Must be between 0 and 65535 (inclusive). The + * seed can prevent hash collisions between network domains, such as a staging + * and production network that use the same addressing scheme. + * <p> + * API name: {@code seed} + */ + @Nullable + public final Integer seed() { + return this.seed; + } + + /** + * If true and any required fields are missing, the processor quietly exits + * without modifying the document. + * <p> + * API name: {@code ignore_missing} + */ + @Nullable + public final Boolean ignoreMissing() { + return this.ignoreMissing; + } + + protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) { + + super.serializeInternal(generator, mapper); + if (this.sourceIp != null) { + generator.writeKey("source_ip"); + generator.write(this.sourceIp); + + } + if (this.sourcePort != null) { + generator.writeKey("source_port"); + generator.write(this.sourcePort); + + } + if (this.destinationIp != null) { + generator.writeKey("destination_ip"); + generator.write(this.destinationIp); + + } + if (this.destinationPort != null) { + generator.writeKey("destination_port"); + generator.write(this.destinationPort); + + } + if (this.ianaNumber != null) { + generator.writeKey("iana_number"); + generator.write(this.ianaNumber); + + } + if (this.icmpType != null) { + generator.writeKey("icmp_type"); + generator.write(this.icmpType); + + } + if (this.icmpCode != null) { + generator.writeKey("icmp_code"); + generator.write(this.icmpCode); + + } + if (this.transport != null) { + generator.writeKey("transport"); + generator.write(this.transport); + + } + if (this.targetField != null) { + generator.writeKey("target_field"); + generator.write(this.targetField); + + } + if (this.seed != null) { + generator.writeKey("seed"); + generator.write(this.seed); + + } + if (this.ignoreMissing != null) { + generator.writeKey("ignore_missing"); + generator.write(this.ignoreMissing); + + } + + } + + // --------------------------------------------------------------------------------------------- + + /** + * Builder for {@link CommunityIDProcessor}. + */ + + public static class Builder extends ProcessorBase.AbstractBuilder<Builder> + implements + ObjectBuilder<CommunityIDProcessor> { + @Nullable + private String sourceIp; + + @Nullable + private String sourcePort; + + @Nullable + private String destinationIp; + + @Nullable + private String destinationPort; + + @Nullable + private String ianaNumber; + + @Nullable + private String icmpType; + + @Nullable + private String icmpCode; + + @Nullable + private String transport; + + @Nullable + private String targetField; + + @Nullable + private Integer seed; + + @Nullable + private Boolean ignoreMissing; + + /** + * Field containing the source IP address. + * <p> + * API name: {@code source_ip} + */ + public final Builder sourceIp(@Nullable String value) { + this.sourceIp = value; + return this; + } + + /** + * Field containing the source port. + * <p> + * API name: {@code source_port} + */ + public final Builder sourcePort(@Nullable String value) { + this.sourcePort = value; + return this; + } + + /** + * Field containing the destination IP address. + * <p> + * API name: {@code destination_ip} + */ + public final Builder destinationIp(@Nullable String value) { + this.destinationIp = value; + return this; + } + + /** + * Field containing the destination port. + * <p> + * API name: {@code destination_port} + */ + public final Builder destinationPort(@Nullable String value) { + this.destinationPort = value; + return this; + } + + /** + * Field containing the IANA number. + * <p> + * API name: {@code iana_number} + */ + public final Builder ianaNumber(@Nullable String value) { + this.ianaNumber = value; + return this; + } + + /** + * Field containing the ICMP type. + * <p> + * API name: {@code icmp_type} + */ + public final Builder icmpType(@Nullable String value) { + this.icmpType = value; + return this; + } + + /** + * Field containing the ICMP code. + * <p> + * API name: {@code icmp_code} + */ + public final Builder icmpCode(@Nullable String value) { + this.icmpCode = value; + return this; + } + + /** + * Field containing the transport protocol name or number. Used only when the + * iana_number field is not present. The following protocol names are currently + * supported: eigrp, gre, icmp, icmpv6, igmp, ipv6-icmp, ospf, pim, sctp, tcp, + * udp + * <p> + * API name: {@code transport} + */ + public final Builder transport(@Nullable String value) { + this.transport = value; + return this; + } + + /** + * Output field for the community ID. + * <p> + * API name: {@code target_field} + */ + public final Builder targetField(@Nullable String value) { + this.targetField = value; + return this; + } + + /** + * Seed for the community ID hash. Must be between 0 and 65535 (inclusive). The + * seed can prevent hash collisions between network domains, such as a staging + * and production network that use the same addressing scheme. + * <p> + * API name: {@code seed} + */ + public final Builder seed(@Nullable Integer value) { + this.seed = value; + return this; + } + + /** + * If true and any required fields are missing, the processor quietly exits + * without modifying the document. + * <p> + * API name: {@code ignore_missing} + */ + public final Builder ignoreMissing(@Nullable Boolean value) { + this.ignoreMissing = value; + return this; + } + + @Override + protected Builder self() { + return this; + } + + /** + * Builds a {@link CommunityIDProcessor}. + * + * @throws NullPointerException + * if some of the required fields are null. + */ + public CommunityIDProcessor build() { + _checkSingleUse(); + + return new CommunityIDProcessor(this); + } + } + + // --------------------------------------------------------------------------------------------- + + /** + * Json deserializer for {@link CommunityIDProcessor} + */ + public static final JsonpDeserializer<CommunityIDProcessor> _DESERIALIZER = ObjectBuilderDeserializer + .lazy(Builder::new, CommunityIDProcessor::setupCommunityIDProcessorDeserializer); + + protected static void setupCommunityIDProcessorDeserializer(ObjectDeserializer<CommunityIDProcessor.Builder> op) { + ProcessorBase.setupProcessorBaseDeserializer(op); + op.add(Builder::sourceIp, JsonpDeserializer.stringDeserializer(), "source_ip"); + op.add(Builder::sourcePort, JsonpDeserializer.stringDeserializer(), "source_port"); + op.add(Builder::destinationIp, JsonpDeserializer.stringDeserializer(), "destination_ip"); + op.add(Builder::destinationPort, JsonpDeserializer.stringDeserializer(), "destination_port"); + op.add(Builder::ianaNumber, JsonpDeserializer.stringDeserializer(), "iana_number"); + op.add(Builder::icmpType, JsonpDeserializer.stringDeserializer(), "icmp_type"); + op.add(Builder::icmpCode, JsonpDeserializer.stringDeserializer(), "icmp_code"); + op.add(Builder::transport, JsonpDeserializer.stringDeserializer(), "transport"); + op.add(Builder::targetField, JsonpDeserializer.stringDeserializer(), "target_field"); + op.add(Builder::seed, JsonpDeserializer.integerDeserializer(), "seed"); + op.add(Builder::ignoreMissing, JsonpDeserializer.booleanDeserializer(), "ignore_missing"); + + } + +} diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/ConvertType.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/ConvertType.java index 8b3d5efdb..7ca65bbcd 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/ConvertType.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/ConvertType.java @@ -49,14 +49,16 @@ public enum ConvertType implements JsonEnum { Long("long"), - Float("float"), - Double("double"), - String("string"), + Float("float"), Boolean("boolean"), + Ip("ip"), + + String("string"), + Auto("auto"), ; diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/DateProcessor.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/DateProcessor.java index 00e807ebd..2fc7265d1 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/DateProcessor.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/DateProcessor.java @@ -70,6 +70,9 @@ public class DateProcessor extends ProcessorBase implements ProcessorVariant { @Nullable private final String timezone; + @Nullable + private final String outputFormat; + // --------------------------------------------------------------------------------------------- private DateProcessor(Builder builder) { @@ -80,6 +83,7 @@ private DateProcessor(Builder builder) { this.locale = builder.locale; this.targetField = builder.targetField; this.timezone = builder.timezone; + this.outputFormat = builder.outputFormat; } @@ -145,6 +149,17 @@ public final String timezone() { return this.timezone; } + /** + * The format to use when writing the date to target_field. Must be a valid java + * time pattern. + * <p> + * API name: {@code output_format} + */ + @Nullable + public final String outputFormat() { + return this.outputFormat; + } + protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) { super.serializeInternal(generator, mapper); @@ -176,6 +191,11 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) { generator.write(this.timezone); } + if (this.outputFormat != null) { + generator.writeKey("output_format"); + generator.write(this.outputFormat); + + } } @@ -199,6 +219,9 @@ public static class Builder extends ProcessorBase.AbstractBuilder<Builder> imple @Nullable private String timezone; + @Nullable + private String outputFormat; + /** * Required - The field to get the date from. * <p> @@ -266,6 +289,17 @@ public final Builder timezone(@Nullable String value) { return this; } + /** + * The format to use when writing the date to target_field. Must be a valid java + * time pattern. + * <p> + * API name: {@code output_format} + */ + public final Builder outputFormat(@Nullable String value) { + this.outputFormat = value; + return this; + } + @Override protected Builder self() { return this; @@ -300,6 +334,7 @@ protected static void setupDateProcessorDeserializer(ObjectDeserializer<DateProc op.add(Builder::locale, JsonpDeserializer.stringDeserializer(), "locale"); op.add(Builder::targetField, JsonpDeserializer.stringDeserializer(), "target_field"); op.add(Builder::timezone, JsonpDeserializer.stringDeserializer(), "timezone"); + op.add(Builder::outputFormat, JsonpDeserializer.stringDeserializer(), "output_format"); } diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/ElasticsearchIngestAsyncClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/ElasticsearchIngestAsyncClient.java index 20815e936..58f960dbe 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/ElasticsearchIngestAsyncClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/ElasticsearchIngestAsyncClient.java @@ -137,7 +137,7 @@ public final CompletableFuture<DeletePipelineResponse> deletePipeline( * Gets download statistics for GeoIP2 databases used with the geoip processor. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/geoip-processor.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/geoip-processor.html">Documentation * on elastic.co</a> */ public CompletableFuture<GeoIpStatsResponse> geoIpStats() { @@ -249,7 +249,7 @@ public CompletableFuture<GetPipelineResponse> getPipeline() { * that supports aliased expressions that can be reused. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/grok-processor.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/grok-processor.html">Documentation * on elastic.co</a> */ public CompletableFuture<ProcessorGrokResponse> processorGrok() { @@ -297,7 +297,7 @@ public final CompletableFuture<PutGeoipDatabaseResponse> putGeoipDatabase( * effect immediately. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ingest.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ingest.html">Documentation * on elastic.co</a> */ @@ -316,7 +316,7 @@ public CompletableFuture<PutPipelineResponse> putPipeline(PutPipelineRequest req * a function that initializes a builder to create the * {@link PutPipelineRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ingest.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ingest.html">Documentation * on elastic.co</a> */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/ElasticsearchIngestClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/ElasticsearchIngestClient.java index 72b348d4b..fb4c9638f 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/ElasticsearchIngestClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/ElasticsearchIngestClient.java @@ -141,7 +141,7 @@ public final DeletePipelineResponse deletePipeline( * Gets download statistics for GeoIP2 databases used with the geoip processor. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/geoip-processor.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/geoip-processor.html">Documentation * on elastic.co</a> */ public GeoIpStatsResponse geoIpStats() throws IOException, ElasticsearchException { @@ -256,7 +256,7 @@ public GetPipelineResponse getPipeline() throws IOException, ElasticsearchExcept * that supports aliased expressions that can be reused. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/grok-processor.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/grok-processor.html">Documentation * on elastic.co</a> */ public ProcessorGrokResponse processorGrok() throws IOException, ElasticsearchException { @@ -306,7 +306,7 @@ public final PutGeoipDatabaseResponse putGeoipDatabase( * effect immediately. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ingest.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ingest.html">Documentation * on elastic.co</a> */ @@ -325,7 +325,7 @@ public PutPipelineResponse putPipeline(PutPipelineRequest request) throws IOExce * a function that initializes a builder to create the * {@link PutPipelineRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ingest.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ingest.html">Documentation * on elastic.co</a> */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/FingerprintDigest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/FingerprintDigest.java new file mode 100644 index 000000000..6e83d2ac9 --- /dev/null +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/FingerprintDigest.java @@ -0,0 +1,72 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package co.elastic.clients.elasticsearch.ingest; + +import co.elastic.clients.json.JsonEnum; +import co.elastic.clients.json.JsonpDeserializable; +import co.elastic.clients.json.JsonpDeserializer; + +//---------------------------------------------------------------- +// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST. +//---------------------------------------------------------------- +// +// This code is generated from the Elasticsearch API specification +// at https://github.com/elastic/elasticsearch-specification +// +// Manual updates to this file will be lost when the code is +// re-generated. +// +// If you find a property that is missing or wrongly typed, please +// open an issue or a PR on the API specification repository. +// +//---------------------------------------------------------------- + +/** + * + * @see <a href="../doc-files/api-spec.html#ingest._types.FingerprintDigest">API + * specification</a> + */ +@JsonpDeserializable +public enum FingerprintDigest implements JsonEnum { + Md5("MD5"), + + Sha1("SHA-1"), + + Sha256("SHA-256"), + + Sha512("SHA-512"), + + MurmurHash3("MurmurHash3"), + + ; + + private final String jsonValue; + + FingerprintDigest(String jsonValue) { + this.jsonValue = jsonValue; + } + + public String jsonValue() { + return this.jsonValue; + } + + public static final JsonEnum.Deserializer<FingerprintDigest> _DESERIALIZER = new JsonEnum.Deserializer<>( + FingerprintDigest.values()); +} diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/FingerprintProcessor.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/FingerprintProcessor.java new file mode 100644 index 000000000..0c17aa105 --- /dev/null +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/FingerprintProcessor.java @@ -0,0 +1,318 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package co.elastic.clients.elasticsearch.ingest; + +import co.elastic.clients.json.JsonpDeserializable; +import co.elastic.clients.json.JsonpDeserializer; +import co.elastic.clients.json.JsonpMapper; +import co.elastic.clients.json.ObjectBuilderDeserializer; +import co.elastic.clients.json.ObjectDeserializer; +import co.elastic.clients.util.ApiTypeHelper; +import co.elastic.clients.util.ObjectBuilder; +import jakarta.json.stream.JsonGenerator; +import java.lang.Boolean; +import java.lang.String; +import java.util.List; +import java.util.Objects; +import java.util.function.Function; +import javax.annotation.Nullable; + +//---------------------------------------------------------------- +// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST. +//---------------------------------------------------------------- +// +// This code is generated from the Elasticsearch API specification +// at https://github.com/elastic/elasticsearch-specification +// +// Manual updates to this file will be lost when the code is +// re-generated. +// +// If you find a property that is missing or wrongly typed, please +// open an issue or a PR on the API specification repository. +// +//---------------------------------------------------------------- + +// typedef: ingest._types.FingerprintProcessor + +/** + * + * @see <a href= + * "../doc-files/api-spec.html#ingest._types.FingerprintProcessor">API + * specification</a> + */ +@JsonpDeserializable +public class FingerprintProcessor extends ProcessorBase implements ProcessorVariant { + private final List<String> fields; + + @Nullable + private final String targetField; + + @Nullable + private final String salt; + + @Nullable + private final FingerprintDigest method; + + @Nullable + private final Boolean ignoreMissing; + + // --------------------------------------------------------------------------------------------- + + private FingerprintProcessor(Builder builder) { + super(builder); + + this.fields = ApiTypeHelper.unmodifiableRequired(builder.fields, this, "fields"); + this.targetField = builder.targetField; + this.salt = builder.salt; + this.method = builder.method; + this.ignoreMissing = builder.ignoreMissing; + + } + + public static FingerprintProcessor of(Function<Builder, ObjectBuilder<FingerprintProcessor>> fn) { + return fn.apply(new Builder()).build(); + } + + /** + * Processor variant kind. + */ + @Override + public Processor.Kind _processorKind() { + return Processor.Kind.Fingerprint; + } + + /** + * Required - Array of fields to include in the fingerprint. For objects, the + * processor hashes both the field key and value. For other fields, the + * processor hashes only the field value. + * <p> + * API name: {@code fields} + */ + public final List<String> fields() { + return this.fields; + } + + /** + * Output field for the fingerprint. + * <p> + * API name: {@code target_field} + */ + @Nullable + public final String targetField() { + return this.targetField; + } + + /** + * Salt value for the hash function. + * <p> + * API name: {@code salt} + */ + @Nullable + public final String salt() { + return this.salt; + } + + /** + * The hash method used to compute the fingerprint. Must be one of MD5, SHA-1, + * SHA-256, SHA-512, or MurmurHash3. + * <p> + * API name: {@code method} + */ + @Nullable + public final FingerprintDigest method() { + return this.method; + } + + /** + * If true, the processor ignores any missing fields. If all fields are missing, + * the processor silently exits without modifying the document. + * <p> + * API name: {@code ignore_missing} + */ + @Nullable + public final Boolean ignoreMissing() { + return this.ignoreMissing; + } + + protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) { + + super.serializeInternal(generator, mapper); + if (ApiTypeHelper.isDefined(this.fields)) { + generator.writeKey("fields"); + generator.writeStartArray(); + for (String item0 : this.fields) { + generator.write(item0); + + } + generator.writeEnd(); + + } + if (this.targetField != null) { + generator.writeKey("target_field"); + generator.write(this.targetField); + + } + if (this.salt != null) { + generator.writeKey("salt"); + generator.write(this.salt); + + } + if (this.method != null) { + generator.writeKey("method"); + this.method.serialize(generator, mapper); + } + if (this.ignoreMissing != null) { + generator.writeKey("ignore_missing"); + generator.write(this.ignoreMissing); + + } + + } + + // --------------------------------------------------------------------------------------------- + + /** + * Builder for {@link FingerprintProcessor}. + */ + + public static class Builder extends ProcessorBase.AbstractBuilder<Builder> + implements + ObjectBuilder<FingerprintProcessor> { + private List<String> fields; + + @Nullable + private String targetField; + + @Nullable + private String salt; + + @Nullable + private FingerprintDigest method; + + @Nullable + private Boolean ignoreMissing; + + /** + * Required - Array of fields to include in the fingerprint. For objects, the + * processor hashes both the field key and value. For other fields, the + * processor hashes only the field value. + * <p> + * API name: {@code fields} + * <p> + * Adds all elements of <code>list</code> to <code>fields</code>. + */ + public final Builder fields(List<String> list) { + this.fields = _listAddAll(this.fields, list); + return this; + } + + /** + * Required - Array of fields to include in the fingerprint. For objects, the + * processor hashes both the field key and value. For other fields, the + * processor hashes only the field value. + * <p> + * API name: {@code fields} + * <p> + * Adds one or more values to <code>fields</code>. + */ + public final Builder fields(String value, String... values) { + this.fields = _listAdd(this.fields, value, values); + return this; + } + + /** + * Output field for the fingerprint. + * <p> + * API name: {@code target_field} + */ + public final Builder targetField(@Nullable String value) { + this.targetField = value; + return this; + } + + /** + * Salt value for the hash function. + * <p> + * API name: {@code salt} + */ + public final Builder salt(@Nullable String value) { + this.salt = value; + return this; + } + + /** + * The hash method used to compute the fingerprint. Must be one of MD5, SHA-1, + * SHA-256, SHA-512, or MurmurHash3. + * <p> + * API name: {@code method} + */ + public final Builder method(@Nullable FingerprintDigest value) { + this.method = value; + return this; + } + + /** + * If true, the processor ignores any missing fields. If all fields are missing, + * the processor silently exits without modifying the document. + * <p> + * API name: {@code ignore_missing} + */ + public final Builder ignoreMissing(@Nullable Boolean value) { + this.ignoreMissing = value; + return this; + } + + @Override + protected Builder self() { + return this; + } + + /** + * Builds a {@link FingerprintProcessor}. + * + * @throws NullPointerException + * if some of the required fields are null. + */ + public FingerprintProcessor build() { + _checkSingleUse(); + + return new FingerprintProcessor(this); + } + } + + // --------------------------------------------------------------------------------------------- + + /** + * Json deserializer for {@link FingerprintProcessor} + */ + public static final JsonpDeserializer<FingerprintProcessor> _DESERIALIZER = ObjectBuilderDeserializer + .lazy(Builder::new, FingerprintProcessor::setupFingerprintProcessorDeserializer); + + protected static void setupFingerprintProcessorDeserializer(ObjectDeserializer<FingerprintProcessor.Builder> op) { + ProcessorBase.setupProcessorBaseDeserializer(op); + op.add(Builder::fields, JsonpDeserializer.arrayDeserializer(JsonpDeserializer.stringDeserializer()), "fields"); + op.add(Builder::targetField, JsonpDeserializer.stringDeserializer(), "target_field"); + op.add(Builder::salt, JsonpDeserializer.stringDeserializer(), "salt"); + op.add(Builder::method, FingerprintDigest._DESERIALIZER, "method"); + op.add(Builder::ignoreMissing, JsonpDeserializer.booleanDeserializer(), "ignore_missing"); + + } + +} diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/GrokProcessor.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/GrokProcessor.java index e3ce15c28..30ef80165 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/GrokProcessor.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/GrokProcessor.java @@ -59,6 +59,9 @@ */ @JsonpDeserializable public class GrokProcessor extends ProcessorBase implements ProcessorVariant { + @Nullable + private final String ecsCompatibility; + private final String field; @Nullable @@ -76,6 +79,7 @@ public class GrokProcessor extends ProcessorBase implements ProcessorVariant { private GrokProcessor(Builder builder) { super(builder); + this.ecsCompatibility = builder.ecsCompatibility; this.field = ApiTypeHelper.requireNonNull(builder.field, this, "field"); this.ignoreMissing = builder.ignoreMissing; this.patternDefinitions = ApiTypeHelper.unmodifiable(builder.patternDefinitions); @@ -96,6 +100,17 @@ public Processor.Kind _processorKind() { return Processor.Kind.Grok; } + /** + * Must be disabled or v1. If v1, the processor uses patterns with Elastic + * Common Schema (ECS) field names. + * <p> + * API name: {@code ecs_compatibility} + */ + @Nullable + public final String ecsCompatibility() { + return this.ecsCompatibility; + } + /** * Required - The field to use for grok expression parsing. * <p> @@ -153,6 +168,11 @@ public final Boolean traceMatch() { protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) { super.serializeInternal(generator, mapper); + if (this.ecsCompatibility != null) { + generator.writeKey("ecs_compatibility"); + generator.write(this.ecsCompatibility); + + } generator.writeKey("field"); generator.write(this.field); @@ -197,6 +217,9 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) { */ public static class Builder extends ProcessorBase.AbstractBuilder<Builder> implements ObjectBuilder<GrokProcessor> { + @Nullable + private String ecsCompatibility; + private String field; @Nullable @@ -210,6 +233,17 @@ public static class Builder extends ProcessorBase.AbstractBuilder<Builder> imple @Nullable private Boolean traceMatch; + /** + * Must be disabled or v1. If v1, the processor uses patterns with Elastic + * Common Schema (ECS) field names. + * <p> + * API name: {@code ecs_compatibility} + */ + public final Builder ecsCompatibility(@Nullable String value) { + this.ecsCompatibility = value; + return this; + } + /** * Required - The field to use for grok expression parsing. * <p> @@ -326,6 +360,7 @@ public GrokProcessor build() { protected static void setupGrokProcessorDeserializer(ObjectDeserializer<GrokProcessor.Builder> op) { ProcessorBase.setupProcessorBaseDeserializer(op); + op.add(Builder::ecsCompatibility, JsonpDeserializer.stringDeserializer(), "ecs_compatibility"); op.add(Builder::field, JsonpDeserializer.stringDeserializer(), "field"); op.add(Builder::ignoreMissing, JsonpDeserializer.booleanDeserializer(), "ignore_missing"); op.add(Builder::patternDefinitions, diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/NetworkDirectionProcessor.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/NetworkDirectionProcessor.java new file mode 100644 index 000000000..ed92fcf48 --- /dev/null +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/NetworkDirectionProcessor.java @@ -0,0 +1,358 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package co.elastic.clients.elasticsearch.ingest; + +import co.elastic.clients.json.JsonpDeserializable; +import co.elastic.clients.json.JsonpDeserializer; +import co.elastic.clients.json.JsonpMapper; +import co.elastic.clients.json.ObjectBuilderDeserializer; +import co.elastic.clients.json.ObjectDeserializer; +import co.elastic.clients.util.ApiTypeHelper; +import co.elastic.clients.util.ObjectBuilder; +import jakarta.json.stream.JsonGenerator; +import java.lang.Boolean; +import java.lang.String; +import java.util.List; +import java.util.Objects; +import java.util.function.Function; +import javax.annotation.Nullable; + +//---------------------------------------------------------------- +// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST. +//---------------------------------------------------------------- +// +// This code is generated from the Elasticsearch API specification +// at https://github.com/elastic/elasticsearch-specification +// +// Manual updates to this file will be lost when the code is +// re-generated. +// +// If you find a property that is missing or wrongly typed, please +// open an issue or a PR on the API specification repository. +// +//---------------------------------------------------------------- + +// typedef: ingest._types.NetworkDirectionProcessor + +/** + * + * @see <a href= + * "../doc-files/api-spec.html#ingest._types.NetworkDirectionProcessor">API + * specification</a> + */ +@JsonpDeserializable +public class NetworkDirectionProcessor extends ProcessorBase implements ProcessorVariant { + @Nullable + private final String sourceIp; + + @Nullable + private final String destinationIp; + + @Nullable + private final String targetField; + + private final List<String> internalNetworks; + + @Nullable + private final String internalNetworksField; + + @Nullable + private final Boolean ignoreMissing; + + // --------------------------------------------------------------------------------------------- + + private NetworkDirectionProcessor(Builder builder) { + super(builder); + + this.sourceIp = builder.sourceIp; + this.destinationIp = builder.destinationIp; + this.targetField = builder.targetField; + this.internalNetworks = ApiTypeHelper.unmodifiable(builder.internalNetworks); + this.internalNetworksField = builder.internalNetworksField; + this.ignoreMissing = builder.ignoreMissing; + + } + + public static NetworkDirectionProcessor of(Function<Builder, ObjectBuilder<NetworkDirectionProcessor>> fn) { + return fn.apply(new Builder()).build(); + } + + /** + * Processor variant kind. + */ + @Override + public Processor.Kind _processorKind() { + return Processor.Kind.NetworkDirection; + } + + /** + * Field containing the source IP address. + * <p> + * API name: {@code source_ip} + */ + @Nullable + public final String sourceIp() { + return this.sourceIp; + } + + /** + * Field containing the destination IP address. + * <p> + * API name: {@code destination_ip} + */ + @Nullable + public final String destinationIp() { + return this.destinationIp; + } + + /** + * Output field for the network direction. + * <p> + * API name: {@code target_field} + */ + @Nullable + public final String targetField() { + return this.targetField; + } + + /** + * List of internal networks. Supports IPv4 and IPv6 addresses and ranges in + * CIDR notation. Also supports the named ranges listed below. These may be + * constructed with template snippets. Must specify only one of + * internal_networks or internal_networks_field. + * <p> + * API name: {@code internal_networks} + */ + public final List<String> internalNetworks() { + return this.internalNetworks; + } + + /** + * A field on the given document to read the internal_networks configuration + * from. + * <p> + * API name: {@code internal_networks_field} + */ + @Nullable + public final String internalNetworksField() { + return this.internalNetworksField; + } + + /** + * If true and any required fields are missing, the processor quietly exits + * without modifying the document. + * <p> + * API name: {@code ignore_missing} + */ + @Nullable + public final Boolean ignoreMissing() { + return this.ignoreMissing; + } + + protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) { + + super.serializeInternal(generator, mapper); + if (this.sourceIp != null) { + generator.writeKey("source_ip"); + generator.write(this.sourceIp); + + } + if (this.destinationIp != null) { + generator.writeKey("destination_ip"); + generator.write(this.destinationIp); + + } + if (this.targetField != null) { + generator.writeKey("target_field"); + generator.write(this.targetField); + + } + if (ApiTypeHelper.isDefined(this.internalNetworks)) { + generator.writeKey("internal_networks"); + generator.writeStartArray(); + for (String item0 : this.internalNetworks) { + generator.write(item0); + + } + generator.writeEnd(); + + } + if (this.internalNetworksField != null) { + generator.writeKey("internal_networks_field"); + generator.write(this.internalNetworksField); + + } + if (this.ignoreMissing != null) { + generator.writeKey("ignore_missing"); + generator.write(this.ignoreMissing); + + } + + } + + // --------------------------------------------------------------------------------------------- + + /** + * Builder for {@link NetworkDirectionProcessor}. + */ + + public static class Builder extends ProcessorBase.AbstractBuilder<Builder> + implements + ObjectBuilder<NetworkDirectionProcessor> { + @Nullable + private String sourceIp; + + @Nullable + private String destinationIp; + + @Nullable + private String targetField; + + @Nullable + private List<String> internalNetworks; + + @Nullable + private String internalNetworksField; + + @Nullable + private Boolean ignoreMissing; + + /** + * Field containing the source IP address. + * <p> + * API name: {@code source_ip} + */ + public final Builder sourceIp(@Nullable String value) { + this.sourceIp = value; + return this; + } + + /** + * Field containing the destination IP address. + * <p> + * API name: {@code destination_ip} + */ + public final Builder destinationIp(@Nullable String value) { + this.destinationIp = value; + return this; + } + + /** + * Output field for the network direction. + * <p> + * API name: {@code target_field} + */ + public final Builder targetField(@Nullable String value) { + this.targetField = value; + return this; + } + + /** + * List of internal networks. Supports IPv4 and IPv6 addresses and ranges in + * CIDR notation. Also supports the named ranges listed below. These may be + * constructed with template snippets. Must specify only one of + * internal_networks or internal_networks_field. + * <p> + * API name: {@code internal_networks} + * <p> + * Adds all elements of <code>list</code> to <code>internalNetworks</code>. + */ + public final Builder internalNetworks(List<String> list) { + this.internalNetworks = _listAddAll(this.internalNetworks, list); + return this; + } + + /** + * List of internal networks. Supports IPv4 and IPv6 addresses and ranges in + * CIDR notation. Also supports the named ranges listed below. These may be + * constructed with template snippets. Must specify only one of + * internal_networks or internal_networks_field. + * <p> + * API name: {@code internal_networks} + * <p> + * Adds one or more values to <code>internalNetworks</code>. + */ + public final Builder internalNetworks(String value, String... values) { + this.internalNetworks = _listAdd(this.internalNetworks, value, values); + return this; + } + + /** + * A field on the given document to read the internal_networks configuration + * from. + * <p> + * API name: {@code internal_networks_field} + */ + public final Builder internalNetworksField(@Nullable String value) { + this.internalNetworksField = value; + return this; + } + + /** + * If true and any required fields are missing, the processor quietly exits + * without modifying the document. + * <p> + * API name: {@code ignore_missing} + */ + public final Builder ignoreMissing(@Nullable Boolean value) { + this.ignoreMissing = value; + return this; + } + + @Override + protected Builder self() { + return this; + } + + /** + * Builds a {@link NetworkDirectionProcessor}. + * + * @throws NullPointerException + * if some of the required fields are null. + */ + public NetworkDirectionProcessor build() { + _checkSingleUse(); + + return new NetworkDirectionProcessor(this); + } + } + + // --------------------------------------------------------------------------------------------- + + /** + * Json deserializer for {@link NetworkDirectionProcessor} + */ + public static final JsonpDeserializer<NetworkDirectionProcessor> _DESERIALIZER = ObjectBuilderDeserializer + .lazy(Builder::new, NetworkDirectionProcessor::setupNetworkDirectionProcessorDeserializer); + + protected static void setupNetworkDirectionProcessorDeserializer( + ObjectDeserializer<NetworkDirectionProcessor.Builder> op) { + ProcessorBase.setupProcessorBaseDeserializer(op); + op.add(Builder::sourceIp, JsonpDeserializer.stringDeserializer(), "source_ip"); + op.add(Builder::destinationIp, JsonpDeserializer.stringDeserializer(), "destination_ip"); + op.add(Builder::targetField, JsonpDeserializer.stringDeserializer(), "target_field"); + op.add(Builder::internalNetworks, JsonpDeserializer.arrayDeserializer(JsonpDeserializer.stringDeserializer()), + "internal_networks"); + op.add(Builder::internalNetworksField, JsonpDeserializer.stringDeserializer(), "internal_networks_field"); + op.add(Builder::ignoreMissing, JsonpDeserializer.booleanDeserializer(), "ignore_missing"); + + } + +} diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/Processor.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/Processor.java index 75ac6415e..489acf9e6 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/Processor.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/Processor.java @@ -82,6 +82,8 @@ public enum Kind implements JsonEnum { Circle("circle"), + CommunityId("community_id"), + Convert("convert"), Csv("csv"), @@ -100,6 +102,8 @@ public enum Kind implements JsonEnum { Fail("fail"), + Fingerprint("fingerprint"), + Foreach("foreach"), GeoGrid("geo_grid"), @@ -122,10 +126,14 @@ public enum Kind implements JsonEnum { Lowercase("lowercase"), + NetworkDirection("network_direction"), + Pipeline("pipeline"), Redact("redact"), + RegisteredDomain("registered_domain"), + Remove("remove"), Rename("rename"), @@ -272,6 +280,23 @@ public CircleProcessor circle() { return TaggedUnionUtils.get(this, Kind.Circle); } + /** + * Is this variant instance of kind {@code community_id}? + */ + public boolean isCommunityId() { + return _kind == Kind.CommunityId; + } + + /** + * Get the {@code community_id} variant value. + * + * @throws IllegalStateException + * if the current variant is not of the {@code community_id} kind. + */ + public CommunityIDProcessor communityId() { + return TaggedUnionUtils.get(this, Kind.CommunityId); + } + /** * Is this variant instance of kind {@code convert}? */ @@ -426,6 +451,23 @@ public FailProcessor fail() { return TaggedUnionUtils.get(this, Kind.Fail); } + /** + * Is this variant instance of kind {@code fingerprint}? + */ + public boolean isFingerprint() { + return _kind == Kind.Fingerprint; + } + + /** + * Get the {@code fingerprint} variant value. + * + * @throws IllegalStateException + * if the current variant is not of the {@code fingerprint} kind. + */ + public FingerprintProcessor fingerprint() { + return TaggedUnionUtils.get(this, Kind.Fingerprint); + } + /** * Is this variant instance of kind {@code foreach}? */ @@ -613,6 +655,24 @@ public LowercaseProcessor lowercase() { return TaggedUnionUtils.get(this, Kind.Lowercase); } + /** + * Is this variant instance of kind {@code network_direction}? + */ + public boolean isNetworkDirection() { + return _kind == Kind.NetworkDirection; + } + + /** + * Get the {@code network_direction} variant value. + * + * @throws IllegalStateException + * if the current variant is not of the {@code network_direction} + * kind. + */ + public NetworkDirectionProcessor networkDirection() { + return TaggedUnionUtils.get(this, Kind.NetworkDirection); + } + /** * Is this variant instance of kind {@code pipeline}? */ @@ -647,6 +707,24 @@ public RedactProcessor redact() { return TaggedUnionUtils.get(this, Kind.Redact); } + /** + * Is this variant instance of kind {@code registered_domain}? + */ + public boolean isRegisteredDomain() { + return _kind == Kind.RegisteredDomain; + } + + /** + * Get the {@code registered_domain} variant value. + * + * @throws IllegalStateException + * if the current variant is not of the {@code registered_domain} + * kind. + */ + public RegisteredDomainProcessor registeredDomain() { + return TaggedUnionUtils.get(this, Kind.RegisteredDomain); + } + /** * Is this variant instance of kind {@code remove}? */ @@ -985,6 +1063,17 @@ public ObjectBuilder<Processor> circle(Function<CircleProcessor.Builder, ObjectB return this.circle(fn.apply(new CircleProcessor.Builder()).build()); } + public ObjectBuilder<Processor> communityId(CommunityIDProcessor v) { + this._kind = Kind.CommunityId; + this._value = v; + return this; + } + + public ObjectBuilder<Processor> communityId( + Function<CommunityIDProcessor.Builder, ObjectBuilder<CommunityIDProcessor>> fn) { + return this.communityId(fn.apply(new CommunityIDProcessor.Builder()).build()); + } + public ObjectBuilder<Processor> convert(ConvertProcessor v) { this._kind = Kind.Convert; this._value = v; @@ -1079,6 +1168,17 @@ public ObjectBuilder<Processor> fail(Function<FailProcessor.Builder, ObjectBuild return this.fail(fn.apply(new FailProcessor.Builder()).build()); } + public ObjectBuilder<Processor> fingerprint(FingerprintProcessor v) { + this._kind = Kind.Fingerprint; + this._value = v; + return this; + } + + public ObjectBuilder<Processor> fingerprint( + Function<FingerprintProcessor.Builder, ObjectBuilder<FingerprintProcessor>> fn) { + return this.fingerprint(fn.apply(new FingerprintProcessor.Builder()).build()); + } + public ObjectBuilder<Processor> foreach(ForeachProcessor v) { this._kind = Kind.Foreach; this._value = v; @@ -1194,6 +1294,17 @@ public ObjectBuilder<Processor> lowercase( return this.lowercase(fn.apply(new LowercaseProcessor.Builder()).build()); } + public ObjectBuilder<Processor> networkDirection(NetworkDirectionProcessor v) { + this._kind = Kind.NetworkDirection; + this._value = v; + return this; + } + + public ObjectBuilder<Processor> networkDirection( + Function<NetworkDirectionProcessor.Builder, ObjectBuilder<NetworkDirectionProcessor>> fn) { + return this.networkDirection(fn.apply(new NetworkDirectionProcessor.Builder()).build()); + } + public ObjectBuilder<Processor> pipeline(PipelineProcessor v) { this._kind = Kind.Pipeline; this._value = v; @@ -1215,6 +1326,17 @@ public ObjectBuilder<Processor> redact(Function<RedactProcessor.Builder, ObjectB return this.redact(fn.apply(new RedactProcessor.Builder()).build()); } + public ObjectBuilder<Processor> registeredDomain(RegisteredDomainProcessor v) { + this._kind = Kind.RegisteredDomain; + this._value = v; + return this; + } + + public ObjectBuilder<Processor> registeredDomain( + Function<RegisteredDomainProcessor.Builder, ObjectBuilder<RegisteredDomainProcessor>> fn) { + return this.registeredDomain(fn.apply(new RegisteredDomainProcessor.Builder()).build()); + } + public ObjectBuilder<Processor> remove(RemoveProcessor v) { this._kind = Kind.Remove; this._value = v; @@ -1391,6 +1513,7 @@ protected static void setupProcessorDeserializer(ObjectDeserializer<Builder> op) op.add(Builder::attachment, AttachmentProcessor._DESERIALIZER, "attachment"); op.add(Builder::bytes, BytesProcessor._DESERIALIZER, "bytes"); op.add(Builder::circle, CircleProcessor._DESERIALIZER, "circle"); + op.add(Builder::communityId, CommunityIDProcessor._DESERIALIZER, "community_id"); op.add(Builder::convert, ConvertProcessor._DESERIALIZER, "convert"); op.add(Builder::csv, CsvProcessor._DESERIALIZER, "csv"); op.add(Builder::date, DateProcessor._DESERIALIZER, "date"); @@ -1400,6 +1523,7 @@ protected static void setupProcessorDeserializer(ObjectDeserializer<Builder> op) op.add(Builder::drop, DropProcessor._DESERIALIZER, "drop"); op.add(Builder::enrich, EnrichProcessor._DESERIALIZER, "enrich"); op.add(Builder::fail, FailProcessor._DESERIALIZER, "fail"); + op.add(Builder::fingerprint, FingerprintProcessor._DESERIALIZER, "fingerprint"); op.add(Builder::foreach, ForeachProcessor._DESERIALIZER, "foreach"); op.add(Builder::geoGrid, GeoGridProcessor._DESERIALIZER, "geo_grid"); op.add(Builder::geoip, GeoIpProcessor._DESERIALIZER, "geoip"); @@ -1411,8 +1535,10 @@ protected static void setupProcessorDeserializer(ObjectDeserializer<Builder> op) op.add(Builder::json, JsonProcessor._DESERIALIZER, "json"); op.add(Builder::kv, KeyValueProcessor._DESERIALIZER, "kv"); op.add(Builder::lowercase, LowercaseProcessor._DESERIALIZER, "lowercase"); + op.add(Builder::networkDirection, NetworkDirectionProcessor._DESERIALIZER, "network_direction"); op.add(Builder::pipeline, PipelineProcessor._DESERIALIZER, "pipeline"); op.add(Builder::redact, RedactProcessor._DESERIALIZER, "redact"); + op.add(Builder::registeredDomain, RegisteredDomainProcessor._DESERIALIZER, "registered_domain"); op.add(Builder::remove, RemoveProcessor._DESERIALIZER, "remove"); op.add(Builder::rename, RenameProcessor._DESERIALIZER, "rename"); op.add(Builder::reroute, RerouteProcessor._DESERIALIZER, "reroute"); diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/ProcessorBuilders.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/ProcessorBuilders.java index 52356f7b5..6aa09cbed 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/ProcessorBuilders.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/ProcessorBuilders.java @@ -116,6 +116,25 @@ public static Processor circle(Function<CircleProcessor.Builder, ObjectBuilder<C return builder.build(); } + /** + * Creates a builder for the {@link CommunityIDProcessor community_id} + * {@code Processor} variant. + */ + public static CommunityIDProcessor.Builder communityId() { + return new CommunityIDProcessor.Builder(); + } + + /** + * Creates a Processor of the {@link CommunityIDProcessor community_id} + * {@code Processor} variant. + */ + public static Processor communityId( + Function<CommunityIDProcessor.Builder, ObjectBuilder<CommunityIDProcessor>> fn) { + Processor.Builder builder = new Processor.Builder(); + builder.communityId(fn.apply(new CommunityIDProcessor.Builder()).build()); + return builder.build(); + } + /** * Creates a builder for the {@link ConvertProcessor convert} {@code Processor} * variant. @@ -279,6 +298,25 @@ public static Processor fail(Function<FailProcessor.Builder, ObjectBuilder<FailP return builder.build(); } + /** + * Creates a builder for the {@link FingerprintProcessor fingerprint} + * {@code Processor} variant. + */ + public static FingerprintProcessor.Builder fingerprint() { + return new FingerprintProcessor.Builder(); + } + + /** + * Creates a Processor of the {@link FingerprintProcessor fingerprint} + * {@code Processor} variant. + */ + public static Processor fingerprint( + Function<FingerprintProcessor.Builder, ObjectBuilder<FingerprintProcessor>> fn) { + Processor.Builder builder = new Processor.Builder(); + builder.fingerprint(fn.apply(new FingerprintProcessor.Builder()).build()); + return builder.build(); + } + /** * Creates a builder for the {@link ForeachProcessor foreach} {@code Processor} * variant. @@ -477,6 +515,25 @@ public static Processor lowercase(Function<LowercaseProcessor.Builder, ObjectBui return builder.build(); } + /** + * Creates a builder for the {@link NetworkDirectionProcessor network_direction} + * {@code Processor} variant. + */ + public static NetworkDirectionProcessor.Builder networkDirection() { + return new NetworkDirectionProcessor.Builder(); + } + + /** + * Creates a Processor of the {@link NetworkDirectionProcessor + * network_direction} {@code Processor} variant. + */ + public static Processor networkDirection( + Function<NetworkDirectionProcessor.Builder, ObjectBuilder<NetworkDirectionProcessor>> fn) { + Processor.Builder builder = new Processor.Builder(); + builder.networkDirection(fn.apply(new NetworkDirectionProcessor.Builder()).build()); + return builder.build(); + } + /** * Creates a builder for the {@link PipelineProcessor pipeline} * {@code Processor} variant. @@ -513,6 +570,25 @@ public static Processor redact(Function<RedactProcessor.Builder, ObjectBuilder<R return builder.build(); } + /** + * Creates a builder for the {@link RegisteredDomainProcessor registered_domain} + * {@code Processor} variant. + */ + public static RegisteredDomainProcessor.Builder registeredDomain() { + return new RegisteredDomainProcessor.Builder(); + } + + /** + * Creates a Processor of the {@link RegisteredDomainProcessor + * registered_domain} {@code Processor} variant. + */ + public static Processor registeredDomain( + Function<RegisteredDomainProcessor.Builder, ObjectBuilder<RegisteredDomainProcessor>> fn) { + Processor.Builder builder = new Processor.Builder(); + builder.registeredDomain(fn.apply(new RegisteredDomainProcessor.Builder()).build()); + return builder.build(); + } + /** * Creates a builder for the {@link RemoveProcessor remove} {@code Processor} * variant. diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/RegisteredDomainProcessor.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/RegisteredDomainProcessor.java new file mode 100644 index 000000000..3b8e22459 --- /dev/null +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/RegisteredDomainProcessor.java @@ -0,0 +1,226 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package co.elastic.clients.elasticsearch.ingest; + +import co.elastic.clients.json.JsonpDeserializable; +import co.elastic.clients.json.JsonpDeserializer; +import co.elastic.clients.json.JsonpMapper; +import co.elastic.clients.json.ObjectBuilderDeserializer; +import co.elastic.clients.json.ObjectDeserializer; +import co.elastic.clients.util.ApiTypeHelper; +import co.elastic.clients.util.ObjectBuilder; +import jakarta.json.stream.JsonGenerator; +import java.lang.Boolean; +import java.lang.String; +import java.util.Objects; +import java.util.function.Function; +import javax.annotation.Nullable; + +//---------------------------------------------------------------- +// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST. +//---------------------------------------------------------------- +// +// This code is generated from the Elasticsearch API specification +// at https://github.com/elastic/elasticsearch-specification +// +// Manual updates to this file will be lost when the code is +// re-generated. +// +// If you find a property that is missing or wrongly typed, please +// open an issue or a PR on the API specification repository. +// +//---------------------------------------------------------------- + +// typedef: ingest._types.RegisteredDomainProcessor + +/** + * + * @see <a href= + * "../doc-files/api-spec.html#ingest._types.RegisteredDomainProcessor">API + * specification</a> + */ +@JsonpDeserializable +public class RegisteredDomainProcessor extends ProcessorBase implements ProcessorVariant { + private final String field; + + @Nullable + private final String targetField; + + @Nullable + private final Boolean ignoreMissing; + + // --------------------------------------------------------------------------------------------- + + private RegisteredDomainProcessor(Builder builder) { + super(builder); + + this.field = ApiTypeHelper.requireNonNull(builder.field, this, "field"); + this.targetField = builder.targetField; + this.ignoreMissing = builder.ignoreMissing; + + } + + public static RegisteredDomainProcessor of(Function<Builder, ObjectBuilder<RegisteredDomainProcessor>> fn) { + return fn.apply(new Builder()).build(); + } + + /** + * Processor variant kind. + */ + @Override + public Processor.Kind _processorKind() { + return Processor.Kind.RegisteredDomain; + } + + /** + * Required - Field containing the source FQDN. + * <p> + * API name: {@code field} + */ + public final String field() { + return this.field; + } + + /** + * Object field containing extracted domain components. If an empty string, the + * processor adds components to the document’s root. + * <p> + * API name: {@code target_field} + */ + @Nullable + public final String targetField() { + return this.targetField; + } + + /** + * If true and any required fields are missing, the processor quietly exits + * without modifying the document. + * <p> + * API name: {@code ignore_missing} + */ + @Nullable + public final Boolean ignoreMissing() { + return this.ignoreMissing; + } + + protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) { + + super.serializeInternal(generator, mapper); + generator.writeKey("field"); + generator.write(this.field); + + if (this.targetField != null) { + generator.writeKey("target_field"); + generator.write(this.targetField); + + } + if (this.ignoreMissing != null) { + generator.writeKey("ignore_missing"); + generator.write(this.ignoreMissing); + + } + + } + + // --------------------------------------------------------------------------------------------- + + /** + * Builder for {@link RegisteredDomainProcessor}. + */ + + public static class Builder extends ProcessorBase.AbstractBuilder<Builder> + implements + ObjectBuilder<RegisteredDomainProcessor> { + private String field; + + @Nullable + private String targetField; + + @Nullable + private Boolean ignoreMissing; + + /** + * Required - Field containing the source FQDN. + * <p> + * API name: {@code field} + */ + public final Builder field(String value) { + this.field = value; + return this; + } + + /** + * Object field containing extracted domain components. If an empty string, the + * processor adds components to the document’s root. + * <p> + * API name: {@code target_field} + */ + public final Builder targetField(@Nullable String value) { + this.targetField = value; + return this; + } + + /** + * If true and any required fields are missing, the processor quietly exits + * without modifying the document. + * <p> + * API name: {@code ignore_missing} + */ + public final Builder ignoreMissing(@Nullable Boolean value) { + this.ignoreMissing = value; + return this; + } + + @Override + protected Builder self() { + return this; + } + + /** + * Builds a {@link RegisteredDomainProcessor}. + * + * @throws NullPointerException + * if some of the required fields are null. + */ + public RegisteredDomainProcessor build() { + _checkSingleUse(); + + return new RegisteredDomainProcessor(this); + } + } + + // --------------------------------------------------------------------------------------------- + + /** + * Json deserializer for {@link RegisteredDomainProcessor} + */ + public static final JsonpDeserializer<RegisteredDomainProcessor> _DESERIALIZER = ObjectBuilderDeserializer + .lazy(Builder::new, RegisteredDomainProcessor::setupRegisteredDomainProcessorDeserializer); + + protected static void setupRegisteredDomainProcessorDeserializer( + ObjectDeserializer<RegisteredDomainProcessor.Builder> op) { + ProcessorBase.setupProcessorBaseDeserializer(op); + op.add(Builder::field, JsonpDeserializer.stringDeserializer(), "field"); + op.add(Builder::targetField, JsonpDeserializer.stringDeserializer(), "target_field"); + op.add(Builder::ignoreMissing, JsonpDeserializer.booleanDeserializer(), "ignore_missing"); + + } + +} diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ml/ElasticsearchMlAsyncClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ml/ElasticsearchMlAsyncClient.java index 54cc2ef2f..2ed26bfaf 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ml/ElasticsearchMlAsyncClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ml/ElasticsearchMlAsyncClient.java @@ -128,7 +128,7 @@ public final CompletableFuture<ClearTrainedModelDeploymentCacheResponse> clearTr * date stops, it automatically closes its associated job. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ml-close-job.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-close-job.html">Documentation * on elastic.co</a> */ @@ -159,7 +159,7 @@ public CompletableFuture<CloseJobResponse> closeJob(CloseJobRequest request) { * a function that initializes a builder to create the * {@link CloseJobRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ml-close-job.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-close-job.html">Documentation * on elastic.co</a> */ @@ -175,7 +175,7 @@ public final CompletableFuture<CloseJobResponse> closeJob( * it. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ml-delete-calendar.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-delete-calendar.html">Documentation * on elastic.co</a> */ @@ -194,7 +194,7 @@ public CompletableFuture<DeleteCalendarResponse> deleteCalendar(DeleteCalendarRe * a function that initializes a builder to create the * {@link DeleteCalendarRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ml-delete-calendar.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-delete-calendar.html">Documentation * on elastic.co</a> */ @@ -209,7 +209,7 @@ public final CompletableFuture<DeleteCalendarResponse> deleteCalendar( * Delete events from a calendar. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ml-delete-calendar-event.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-delete-calendar-event.html">Documentation * on elastic.co</a> */ @@ -227,7 +227,7 @@ public CompletableFuture<DeleteCalendarEventResponse> deleteCalendarEvent(Delete * a function that initializes a builder to create the * {@link DeleteCalendarEventRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ml-delete-calendar-event.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-delete-calendar-event.html">Documentation * on elastic.co</a> */ @@ -242,7 +242,7 @@ public final CompletableFuture<DeleteCalendarEventResponse> deleteCalendarEvent( * Delete anomaly jobs from a calendar. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ml-delete-calendar-job.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-delete-calendar-job.html">Documentation * on elastic.co</a> */ @@ -260,7 +260,7 @@ public CompletableFuture<DeleteCalendarJobResponse> deleteCalendarJob(DeleteCale * a function that initializes a builder to create the * {@link DeleteCalendarJobRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ml-delete-calendar-job.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-delete-calendar-job.html">Documentation * on elastic.co</a> */ @@ -275,7 +275,7 @@ public final CompletableFuture<DeleteCalendarJobResponse> deleteCalendarJob( * Delete a data frame analytics job. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-dfanalytics.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-dfanalytics.html">Documentation * on elastic.co</a> */ @@ -294,7 +294,7 @@ public CompletableFuture<DeleteDataFrameAnalyticsResponse> deleteDataFrameAnalyt * a function that initializes a builder to create the * {@link DeleteDataFrameAnalyticsRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-dfanalytics.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-dfanalytics.html">Documentation * on elastic.co</a> */ @@ -309,7 +309,7 @@ public final CompletableFuture<DeleteDataFrameAnalyticsResponse> deleteDataFrame * Delete a datafeed. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ml-delete-datafeed.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-delete-datafeed.html">Documentation * on elastic.co</a> */ @@ -327,7 +327,7 @@ public CompletableFuture<DeleteDatafeedResponse> deleteDatafeed(DeleteDatafeedRe * a function that initializes a builder to create the * {@link DeleteDatafeedRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ml-delete-datafeed.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-delete-datafeed.html">Documentation * on elastic.co</a> */ @@ -2199,7 +2199,7 @@ public final CompletableFuture<PutCalendarJobResponse> putCalendarJob( * a destination index. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/put-dfanalytics.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-dfanalytics.html">Documentation * on elastic.co</a> */ @@ -2220,7 +2220,7 @@ public CompletableFuture<PutDataFrameAnalyticsResponse> putDataFrameAnalytics( * a function that initializes a builder to create the * {@link PutDataFrameAnalyticsRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/put-dfanalytics.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-dfanalytics.html">Documentation * on elastic.co</a> */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ml/ElasticsearchMlClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ml/ElasticsearchMlClient.java index 87751a805..347da76d1 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ml/ElasticsearchMlClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ml/ElasticsearchMlClient.java @@ -130,7 +130,7 @@ public final ClearTrainedModelDeploymentCacheResponse clearTrainedModelDeploymen * date stops, it automatically closes its associated job. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ml-close-job.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-close-job.html">Documentation * on elastic.co</a> */ @@ -161,7 +161,7 @@ public CloseJobResponse closeJob(CloseJobRequest request) throws IOException, El * a function that initializes a builder to create the * {@link CloseJobRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ml-close-job.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-close-job.html">Documentation * on elastic.co</a> */ @@ -177,7 +177,7 @@ public final CloseJobResponse closeJob(Function<CloseJobRequest.Builder, ObjectB * it. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ml-delete-calendar.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-delete-calendar.html">Documentation * on elastic.co</a> */ @@ -197,7 +197,7 @@ public DeleteCalendarResponse deleteCalendar(DeleteCalendarRequest request) * a function that initializes a builder to create the * {@link DeleteCalendarRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ml-delete-calendar.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-delete-calendar.html">Documentation * on elastic.co</a> */ @@ -213,7 +213,7 @@ public final DeleteCalendarResponse deleteCalendar( * Delete events from a calendar. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ml-delete-calendar-event.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-delete-calendar-event.html">Documentation * on elastic.co</a> */ @@ -232,7 +232,7 @@ public DeleteCalendarEventResponse deleteCalendarEvent(DeleteCalendarEventReques * a function that initializes a builder to create the * {@link DeleteCalendarEventRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ml-delete-calendar-event.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-delete-calendar-event.html">Documentation * on elastic.co</a> */ @@ -248,7 +248,7 @@ public final DeleteCalendarEventResponse deleteCalendarEvent( * Delete anomaly jobs from a calendar. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ml-delete-calendar-job.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-delete-calendar-job.html">Documentation * on elastic.co</a> */ @@ -267,7 +267,7 @@ public DeleteCalendarJobResponse deleteCalendarJob(DeleteCalendarJobRequest requ * a function that initializes a builder to create the * {@link DeleteCalendarJobRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ml-delete-calendar-job.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-delete-calendar-job.html">Documentation * on elastic.co</a> */ @@ -283,7 +283,7 @@ public final DeleteCalendarJobResponse deleteCalendarJob( * Delete a data frame analytics job. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-dfanalytics.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-dfanalytics.html">Documentation * on elastic.co</a> */ @@ -302,7 +302,7 @@ public DeleteDataFrameAnalyticsResponse deleteDataFrameAnalytics(DeleteDataFrame * a function that initializes a builder to create the * {@link DeleteDataFrameAnalyticsRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-dfanalytics.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-dfanalytics.html">Documentation * on elastic.co</a> */ @@ -318,7 +318,7 @@ public final DeleteDataFrameAnalyticsResponse deleteDataFrameAnalytics( * Delete a datafeed. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ml-delete-datafeed.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-delete-datafeed.html">Documentation * on elastic.co</a> */ @@ -337,7 +337,7 @@ public DeleteDatafeedResponse deleteDatafeed(DeleteDatafeedRequest request) * a function that initializes a builder to create the * {@link DeleteDatafeedRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ml-delete-datafeed.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-delete-datafeed.html">Documentation * on elastic.co</a> */ @@ -2258,7 +2258,7 @@ public final PutCalendarJobResponse putCalendarJob( * a destination index. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/put-dfanalytics.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-dfanalytics.html">Documentation * on elastic.co</a> */ @@ -2279,7 +2279,7 @@ public PutDataFrameAnalyticsResponse putDataFrameAnalytics(PutDataFrameAnalytics * a function that initializes a builder to create the * {@link PutDataFrameAnalyticsRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/put-dfanalytics.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-dfanalytics.html">Documentation * on elastic.co</a> */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/nodes/ElasticsearchNodesAsyncClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/nodes/ElasticsearchNodesAsyncClient.java index 54364f776..b366280de 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/nodes/ElasticsearchNodesAsyncClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/nodes/ElasticsearchNodesAsyncClient.java @@ -154,7 +154,7 @@ public final CompletableFuture<GetRepositoriesMeteringInfoResponse> getRepositor * threads. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-nodes-hot-threads.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-nodes-hot-threads.html">Documentation * on elastic.co</a> */ @@ -174,7 +174,7 @@ public CompletableFuture<HotThreadsResponse> hotThreads(HotThreadsRequest reques * a function that initializes a builder to create the * {@link HotThreadsRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-nodes-hot-threads.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-nodes-hot-threads.html">Documentation * on elastic.co</a> */ @@ -189,7 +189,7 @@ public final CompletableFuture<HotThreadsResponse> hotThreads( * threads. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-nodes-hot-threads.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-nodes-hot-threads.html">Documentation * on elastic.co</a> */ @@ -204,7 +204,7 @@ public CompletableFuture<HotThreadsResponse> hotThreads() { * Returns cluster nodes information. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-nodes-info.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-nodes-info.html">Documentation * on elastic.co</a> */ @@ -222,7 +222,7 @@ public CompletableFuture<NodesInfoResponse> info(NodesInfoRequest request) { * a function that initializes a builder to create the * {@link NodesInfoRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-nodes-info.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-nodes-info.html">Documentation * on elastic.co</a> */ @@ -235,7 +235,7 @@ public final CompletableFuture<NodesInfoResponse> info( * Returns cluster nodes information. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-nodes-info.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-nodes-info.html">Documentation * on elastic.co</a> */ @@ -296,7 +296,7 @@ public CompletableFuture<ReloadSecureSettingsResponse> reloadSecureSettings() { * Returns cluster nodes statistics. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-nodes-stats.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-nodes-stats.html">Documentation * on elastic.co</a> */ @@ -314,7 +314,7 @@ public CompletableFuture<NodesStatsResponse> stats(NodesStatsRequest request) { * a function that initializes a builder to create the * {@link NodesStatsRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-nodes-stats.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-nodes-stats.html">Documentation * on elastic.co</a> */ @@ -327,7 +327,7 @@ public final CompletableFuture<NodesStatsResponse> stats( * Returns cluster nodes statistics. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-nodes-stats.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-nodes-stats.html">Documentation * on elastic.co</a> */ @@ -342,7 +342,7 @@ public CompletableFuture<NodesStatsResponse> stats() { * Returns information on the usage of features. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-nodes-usage.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-nodes-usage.html">Documentation * on elastic.co</a> */ @@ -360,7 +360,7 @@ public CompletableFuture<NodesUsageResponse> usage(NodesUsageRequest request) { * a function that initializes a builder to create the * {@link NodesUsageRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-nodes-usage.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-nodes-usage.html">Documentation * on elastic.co</a> */ @@ -373,7 +373,7 @@ public final CompletableFuture<NodesUsageResponse> usage( * Returns information on the usage of features. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-nodes-usage.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-nodes-usage.html">Documentation * on elastic.co</a> */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/nodes/ElasticsearchNodesClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/nodes/ElasticsearchNodesClient.java index 3424c6477..bad9f001e 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/nodes/ElasticsearchNodesClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/nodes/ElasticsearchNodesClient.java @@ -156,7 +156,7 @@ public final GetRepositoriesMeteringInfoResponse getRepositoriesMeteringInfo( * threads. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-nodes-hot-threads.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-nodes-hot-threads.html">Documentation * on elastic.co</a> */ @@ -176,7 +176,7 @@ public HotThreadsResponse hotThreads(HotThreadsRequest request) throws IOExcepti * a function that initializes a builder to create the * {@link HotThreadsRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-nodes-hot-threads.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-nodes-hot-threads.html">Documentation * on elastic.co</a> */ @@ -191,7 +191,7 @@ public final HotThreadsResponse hotThreads(Function<HotThreadsRequest.Builder, O * threads. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-nodes-hot-threads.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-nodes-hot-threads.html">Documentation * on elastic.co</a> */ @@ -206,7 +206,7 @@ public HotThreadsResponse hotThreads() throws IOException, ElasticsearchExceptio * Returns cluster nodes information. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-nodes-info.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-nodes-info.html">Documentation * on elastic.co</a> */ @@ -224,7 +224,7 @@ public NodesInfoResponse info(NodesInfoRequest request) throws IOException, Elas * a function that initializes a builder to create the * {@link NodesInfoRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-nodes-info.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-nodes-info.html">Documentation * on elastic.co</a> */ @@ -237,7 +237,7 @@ public final NodesInfoResponse info(Function<NodesInfoRequest.Builder, ObjectBui * Returns cluster nodes information. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-nodes-info.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-nodes-info.html">Documentation * on elastic.co</a> */ @@ -300,7 +300,7 @@ public ReloadSecureSettingsResponse reloadSecureSettings() throws IOException, E * Returns cluster nodes statistics. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-nodes-stats.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-nodes-stats.html">Documentation * on elastic.co</a> */ @@ -318,7 +318,7 @@ public NodesStatsResponse stats(NodesStatsRequest request) throws IOException, E * a function that initializes a builder to create the * {@link NodesStatsRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-nodes-stats.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-nodes-stats.html">Documentation * on elastic.co</a> */ @@ -331,7 +331,7 @@ public final NodesStatsResponse stats(Function<NodesStatsRequest.Builder, Object * Returns cluster nodes statistics. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-nodes-stats.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-nodes-stats.html">Documentation * on elastic.co</a> */ @@ -346,7 +346,7 @@ public NodesStatsResponse stats() throws IOException, ElasticsearchException { * Returns information on the usage of features. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-nodes-usage.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-nodes-usage.html">Documentation * on elastic.co</a> */ @@ -364,7 +364,7 @@ public NodesUsageResponse usage(NodesUsageRequest request) throws IOException, E * a function that initializes a builder to create the * {@link NodesUsageRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-nodes-usage.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-nodes-usage.html">Documentation * on elastic.co</a> */ @@ -377,7 +377,7 @@ public final NodesUsageResponse usage(Function<NodesUsageRequest.Builder, Object * Returns information on the usage of features. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-nodes-usage.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-nodes-usage.html">Documentation * on elastic.co</a> */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/nodes/info/NodeInfoSettingsNetwork.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/nodes/info/NodeInfoSettingsNetwork.java index 961b646d0..6e32f6f0d 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/nodes/info/NodeInfoSettingsNetwork.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/nodes/info/NodeInfoSettingsNetwork.java @@ -26,10 +26,12 @@ import co.elastic.clients.json.JsonpUtils; import co.elastic.clients.json.ObjectBuilderDeserializer; import co.elastic.clients.json.ObjectDeserializer; +import co.elastic.clients.util.ApiTypeHelper; import co.elastic.clients.util.ObjectBuilder; import co.elastic.clients.util.WithJsonObjectBuilderBase; import jakarta.json.stream.JsonGenerator; import java.lang.String; +import java.util.List; import java.util.Objects; import java.util.function.Function; import javax.annotation.Nullable; @@ -59,14 +61,13 @@ */ @JsonpDeserializable public class NodeInfoSettingsNetwork implements JsonpSerializable { - @Nullable - private final String host; + private final List<String> host; // --------------------------------------------------------------------------------------------- private NodeInfoSettingsNetwork(Builder builder) { - this.host = builder.host; + this.host = ApiTypeHelper.unmodifiable(builder.host); } @@ -77,8 +78,7 @@ public static NodeInfoSettingsNetwork of(Function<Builder, ObjectBuilder<NodeInf /** * API name: {@code host} */ - @Nullable - public final String host() { + public final List<String> host() { return this.host; } @@ -93,9 +93,14 @@ public void serialize(JsonGenerator generator, JsonpMapper mapper) { protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) { - if (this.host != null) { + if (ApiTypeHelper.isDefined(this.host)) { generator.writeKey("host"); - generator.write(this.host); + generator.writeStartArray(); + for (String item0 : this.host) { + generator.write(item0); + + } + generator.writeEnd(); } @@ -116,13 +121,25 @@ public static class Builder extends WithJsonObjectBuilderBase<Builder> implements ObjectBuilder<NodeInfoSettingsNetwork> { @Nullable - private String host; + private List<String> host; + + /** + * API name: {@code host} + * <p> + * Adds all elements of <code>list</code> to <code>host</code>. + */ + public final Builder host(List<String> list) { + this.host = _listAddAll(this.host, list); + return this; + } /** * API name: {@code host} + * <p> + * Adds one or more values to <code>host</code>. */ - public final Builder host(@Nullable String value) { - this.host = value; + public final Builder host(String value, String... values) { + this.host = _listAdd(this.host, value, values); return this; } @@ -155,7 +172,7 @@ public NodeInfoSettingsNetwork build() { protected static void setupNodeInfoSettingsNetworkDeserializer( ObjectDeserializer<NodeInfoSettingsNetwork.Builder> op) { - op.add(Builder::host, JsonpDeserializer.stringDeserializer(), "host"); + op.add(Builder::host, JsonpDeserializer.arrayDeserializer(JsonpDeserializer.stringDeserializer()), "host"); } diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/query_rules/ElasticsearchQueryRulesAsyncClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/query_rules/ElasticsearchQueryRulesAsyncClient.java index d46a11ef2..7c322da2b 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/query_rules/ElasticsearchQueryRulesAsyncClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/query_rules/ElasticsearchQueryRulesAsyncClient.java @@ -311,4 +311,36 @@ public final CompletableFuture<PutRulesetResponse> putRuleset( return putRuleset(fn.apply(new PutRulesetRequest.Builder()).build()); } + // ----- Endpoint: query_rules.test + + /** + * Creates or updates a query ruleset. + * + * @see <a href= + * "https://www.elastic.co/guide/en/elasticsearch/reference/master/test-query-ruleset.html">Documentation + * on elastic.co</a> + */ + + public CompletableFuture<TestResponse> test(TestRequest request) { + @SuppressWarnings("unchecked") + JsonEndpoint<TestRequest, TestResponse, ErrorResponse> endpoint = (JsonEndpoint<TestRequest, TestResponse, ErrorResponse>) TestRequest._ENDPOINT; + + return this.transport.performRequestAsync(request, endpoint, this.transportOptions); + } + + /** + * Creates or updates a query ruleset. + * + * @param fn + * a function that initializes a builder to create the + * {@link TestRequest} + * @see <a href= + * "https://www.elastic.co/guide/en/elasticsearch/reference/master/test-query-ruleset.html">Documentation + * on elastic.co</a> + */ + + public final CompletableFuture<TestResponse> test(Function<TestRequest.Builder, ObjectBuilder<TestRequest>> fn) { + return test(fn.apply(new TestRequest.Builder()).build()); + } + } diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/query_rules/ElasticsearchQueryRulesClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/query_rules/ElasticsearchQueryRulesClient.java index 50ddc779c..53367ecde 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/query_rules/ElasticsearchQueryRulesClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/query_rules/ElasticsearchQueryRulesClient.java @@ -313,4 +313,37 @@ public final PutRulesetResponse putRuleset(Function<PutRulesetRequest.Builder, O return putRuleset(fn.apply(new PutRulesetRequest.Builder()).build()); } + // ----- Endpoint: query_rules.test + + /** + * Creates or updates a query ruleset. + * + * @see <a href= + * "https://www.elastic.co/guide/en/elasticsearch/reference/master/test-query-ruleset.html">Documentation + * on elastic.co</a> + */ + + public TestResponse test(TestRequest request) throws IOException, ElasticsearchException { + @SuppressWarnings("unchecked") + JsonEndpoint<TestRequest, TestResponse, ErrorResponse> endpoint = (JsonEndpoint<TestRequest, TestResponse, ErrorResponse>) TestRequest._ENDPOINT; + + return this.transport.performRequest(request, endpoint, this.transportOptions); + } + + /** + * Creates or updates a query ruleset. + * + * @param fn + * a function that initializes a builder to create the + * {@link TestRequest} + * @see <a href= + * "https://www.elastic.co/guide/en/elasticsearch/reference/master/test-query-ruleset.html">Documentation + * on elastic.co</a> + */ + + public final TestResponse test(Function<TestRequest.Builder, ObjectBuilder<TestRequest>> fn) + throws IOException, ElasticsearchException { + return test(fn.apply(new TestRequest.Builder()).build()); + } + } diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/query_rules/TestRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/query_rules/TestRequest.java new file mode 100644 index 000000000..9c7777941 --- /dev/null +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/query_rules/TestRequest.java @@ -0,0 +1,257 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package co.elastic.clients.elasticsearch.query_rules; + +import co.elastic.clients.elasticsearch._types.ErrorResponse; +import co.elastic.clients.elasticsearch._types.RequestBase; +import co.elastic.clients.json.JsonData; +import co.elastic.clients.json.JsonpDeserializable; +import co.elastic.clients.json.JsonpDeserializer; +import co.elastic.clients.json.JsonpMapper; +import co.elastic.clients.json.JsonpSerializable; +import co.elastic.clients.json.ObjectBuilderDeserializer; +import co.elastic.clients.json.ObjectDeserializer; +import co.elastic.clients.transport.Endpoint; +import co.elastic.clients.transport.endpoints.SimpleEndpoint; +import co.elastic.clients.util.ApiTypeHelper; +import co.elastic.clients.util.ObjectBuilder; +import jakarta.json.stream.JsonGenerator; +import java.lang.String; +import java.util.Collections; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.function.Function; +import javax.annotation.Nullable; + +//---------------------------------------------------------------- +// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST. +//---------------------------------------------------------------- +// +// This code is generated from the Elasticsearch API specification +// at https://github.com/elastic/elasticsearch-specification +// +// Manual updates to this file will be lost when the code is +// re-generated. +// +// If you find a property that is missing or wrongly typed, please +// open an issue or a PR on the API specification repository. +// +//---------------------------------------------------------------- + +// typedef: query_rules.test.Request + +/** + * Creates or updates a query ruleset. + * + * @see <a href="../doc-files/api-spec.html#query_rules.test.Request">API + * specification</a> + */ +@JsonpDeserializable +public class TestRequest extends RequestBase implements JsonpSerializable { + private final Map<String, JsonData> matchCriteria; + + private final String rulesetId; + + // --------------------------------------------------------------------------------------------- + + private TestRequest(Builder builder) { + + this.matchCriteria = ApiTypeHelper.unmodifiableRequired(builder.matchCriteria, this, "matchCriteria"); + this.rulesetId = ApiTypeHelper.requireNonNull(builder.rulesetId, this, "rulesetId"); + + } + + public static TestRequest of(Function<Builder, ObjectBuilder<TestRequest>> fn) { + return fn.apply(new Builder()).build(); + } + + /** + * Required - API name: {@code match_criteria} + */ + public final Map<String, JsonData> matchCriteria() { + return this.matchCriteria; + } + + /** + * Required - The unique identifier of the query ruleset to be created or + * updated + * <p> + * API name: {@code ruleset_id} + */ + public final String rulesetId() { + return this.rulesetId; + } + + /** + * Serialize this object to JSON. + */ + public void serialize(JsonGenerator generator, JsonpMapper mapper) { + generator.writeStartObject(); + serializeInternal(generator, mapper); + generator.writeEnd(); + } + + protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) { + + if (ApiTypeHelper.isDefined(this.matchCriteria)) { + generator.writeKey("match_criteria"); + generator.writeStartObject(); + for (Map.Entry<String, JsonData> item0 : this.matchCriteria.entrySet()) { + generator.writeKey(item0.getKey()); + item0.getValue().serialize(generator, mapper); + + } + generator.writeEnd(); + + } + + } + + // --------------------------------------------------------------------------------------------- + + /** + * Builder for {@link TestRequest}. + */ + + public static class Builder extends RequestBase.AbstractBuilder<Builder> implements ObjectBuilder<TestRequest> { + private Map<String, JsonData> matchCriteria; + + private String rulesetId; + + /** + * Required - API name: {@code match_criteria} + * <p> + * Adds all entries of <code>map</code> to <code>matchCriteria</code>. + */ + public final Builder matchCriteria(Map<String, JsonData> map) { + this.matchCriteria = _mapPutAll(this.matchCriteria, map); + return this; + } + + /** + * Required - API name: {@code match_criteria} + * <p> + * Adds an entry to <code>matchCriteria</code>. + */ + public final Builder matchCriteria(String key, JsonData value) { + this.matchCriteria = _mapPut(this.matchCriteria, key, value); + return this; + } + + /** + * Required - The unique identifier of the query ruleset to be created or + * updated + * <p> + * API name: {@code ruleset_id} + */ + public final Builder rulesetId(String value) { + this.rulesetId = value; + return this; + } + + @Override + protected Builder self() { + return this; + } + + /** + * Builds a {@link TestRequest}. + * + * @throws NullPointerException + * if some of the required fields are null. + */ + public TestRequest build() { + _checkSingleUse(); + + return new TestRequest(this); + } + } + + // --------------------------------------------------------------------------------------------- + + /** + * Json deserializer for {@link TestRequest} + */ + public static final JsonpDeserializer<TestRequest> _DESERIALIZER = ObjectBuilderDeserializer.lazy(Builder::new, + TestRequest::setupTestRequestDeserializer); + + protected static void setupTestRequestDeserializer(ObjectDeserializer<TestRequest.Builder> op) { + + op.add(Builder::matchCriteria, JsonpDeserializer.stringMapDeserializer(JsonData._DESERIALIZER), + "match_criteria"); + + } + + // --------------------------------------------------------------------------------------------- + + /** + * Endpoint "{@code query_rules.test}". + */ + public static final Endpoint<TestRequest, TestResponse, ErrorResponse> _ENDPOINT = new SimpleEndpoint<>( + "es/query_rules.test", + + // Request method + request -> { + return "POST"; + + }, + + // Request path + request -> { + final int _rulesetId = 1 << 0; + + int propsSet = 0; + + propsSet |= _rulesetId; + + if (propsSet == (_rulesetId)) { + StringBuilder buf = new StringBuilder(); + buf.append("/_query_rules"); + buf.append("/"); + SimpleEndpoint.pathEncode(request.rulesetId, buf); + buf.append("/_test"); + return buf.toString(); + } + throw SimpleEndpoint.noPathTemplateFound("path"); + + }, + + // Path parameters + request -> { + Map<String, String> params = new HashMap<>(); + final int _rulesetId = 1 << 0; + + int propsSet = 0; + + propsSet |= _rulesetId; + + if (propsSet == (_rulesetId)) { + params.put("rulesetId", request.rulesetId); + } + return params; + }, + + // Request parameters + request -> { + return Collections.emptyMap(); + + }, SimpleEndpoint.emptyMap(), true, TestResponse._DESERIALIZER); +} diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/query_rules/TestResponse.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/query_rules/TestResponse.java new file mode 100644 index 000000000..c1a655ce6 --- /dev/null +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/query_rules/TestResponse.java @@ -0,0 +1,210 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package co.elastic.clients.elasticsearch.query_rules; + +import co.elastic.clients.elasticsearch.query_rules.test.QueryRulesetMatchedRule; +import co.elastic.clients.json.JsonpDeserializable; +import co.elastic.clients.json.JsonpDeserializer; +import co.elastic.clients.json.JsonpMapper; +import co.elastic.clients.json.JsonpSerializable; +import co.elastic.clients.json.JsonpUtils; +import co.elastic.clients.json.ObjectBuilderDeserializer; +import co.elastic.clients.json.ObjectDeserializer; +import co.elastic.clients.util.ApiTypeHelper; +import co.elastic.clients.util.ObjectBuilder; +import co.elastic.clients.util.WithJsonObjectBuilderBase; +import jakarta.json.stream.JsonGenerator; +import java.lang.Integer; +import java.util.List; +import java.util.Objects; +import java.util.function.Function; +import javax.annotation.Nullable; + +//---------------------------------------------------------------- +// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST. +//---------------------------------------------------------------- +// +// This code is generated from the Elasticsearch API specification +// at https://github.com/elastic/elasticsearch-specification +// +// Manual updates to this file will be lost when the code is +// re-generated. +// +// If you find a property that is missing or wrongly typed, please +// open an issue or a PR on the API specification repository. +// +//---------------------------------------------------------------- + +// typedef: query_rules.test.Response + +/** + * + * @see <a href="../doc-files/api-spec.html#query_rules.test.Response">API + * specification</a> + */ +@JsonpDeserializable +public class TestResponse implements JsonpSerializable { + private final int totalMatchedRules; + + private final List<QueryRulesetMatchedRule> matchedRules; + + // --------------------------------------------------------------------------------------------- + + private TestResponse(Builder builder) { + + this.totalMatchedRules = ApiTypeHelper.requireNonNull(builder.totalMatchedRules, this, "totalMatchedRules"); + this.matchedRules = ApiTypeHelper.unmodifiableRequired(builder.matchedRules, this, "matchedRules"); + + } + + public static TestResponse of(Function<Builder, ObjectBuilder<TestResponse>> fn) { + return fn.apply(new Builder()).build(); + } + + /** + * Required - API name: {@code total_matched_rules} + */ + public final int totalMatchedRules() { + return this.totalMatchedRules; + } + + /** + * Required - API name: {@code matched_rules} + */ + public final List<QueryRulesetMatchedRule> matchedRules() { + return this.matchedRules; + } + + /** + * Serialize this object to JSON. + */ + public void serialize(JsonGenerator generator, JsonpMapper mapper) { + generator.writeStartObject(); + serializeInternal(generator, mapper); + generator.writeEnd(); + } + + protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) { + + generator.writeKey("total_matched_rules"); + generator.write(this.totalMatchedRules); + + if (ApiTypeHelper.isDefined(this.matchedRules)) { + generator.writeKey("matched_rules"); + generator.writeStartArray(); + for (QueryRulesetMatchedRule item0 : this.matchedRules) { + item0.serialize(generator, mapper); + + } + generator.writeEnd(); + + } + + } + + @Override + public String toString() { + return JsonpUtils.toString(this); + } + + // --------------------------------------------------------------------------------------------- + + /** + * Builder for {@link TestResponse}. + */ + + public static class Builder extends WithJsonObjectBuilderBase<Builder> implements ObjectBuilder<TestResponse> { + private Integer totalMatchedRules; + + private List<QueryRulesetMatchedRule> matchedRules; + + /** + * Required - API name: {@code total_matched_rules} + */ + public final Builder totalMatchedRules(int value) { + this.totalMatchedRules = value; + return this; + } + + /** + * Required - API name: {@code matched_rules} + * <p> + * Adds all elements of <code>list</code> to <code>matchedRules</code>. + */ + public final Builder matchedRules(List<QueryRulesetMatchedRule> list) { + this.matchedRules = _listAddAll(this.matchedRules, list); + return this; + } + + /** + * Required - API name: {@code matched_rules} + * <p> + * Adds one or more values to <code>matchedRules</code>. + */ + public final Builder matchedRules(QueryRulesetMatchedRule value, QueryRulesetMatchedRule... values) { + this.matchedRules = _listAdd(this.matchedRules, value, values); + return this; + } + + /** + * Required - API name: {@code matched_rules} + * <p> + * Adds a value to <code>matchedRules</code> using a builder lambda. + */ + public final Builder matchedRules( + Function<QueryRulesetMatchedRule.Builder, ObjectBuilder<QueryRulesetMatchedRule>> fn) { + return matchedRules(fn.apply(new QueryRulesetMatchedRule.Builder()).build()); + } + + @Override + protected Builder self() { + return this; + } + + /** + * Builds a {@link TestResponse}. + * + * @throws NullPointerException + * if some of the required fields are null. + */ + public TestResponse build() { + _checkSingleUse(); + + return new TestResponse(this); + } + } + + // --------------------------------------------------------------------------------------------- + + /** + * Json deserializer for {@link TestResponse} + */ + public static final JsonpDeserializer<TestResponse> _DESERIALIZER = ObjectBuilderDeserializer.lazy(Builder::new, + TestResponse::setupTestResponseDeserializer); + + protected static void setupTestResponseDeserializer(ObjectDeserializer<TestResponse.Builder> op) { + + op.add(Builder::totalMatchedRules, JsonpDeserializer.integerDeserializer(), "total_matched_rules"); + op.add(Builder::matchedRules, JsonpDeserializer.arrayDeserializer(QueryRulesetMatchedRule._DESERIALIZER), + "matched_rules"); + + } + +} diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/query_rules/test/QueryRulesetMatchedRule.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/query_rules/test/QueryRulesetMatchedRule.java new file mode 100644 index 000000000..897df01eb --- /dev/null +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/query_rules/test/QueryRulesetMatchedRule.java @@ -0,0 +1,189 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package co.elastic.clients.elasticsearch.query_rules.test; + +import co.elastic.clients.json.JsonpDeserializable; +import co.elastic.clients.json.JsonpDeserializer; +import co.elastic.clients.json.JsonpMapper; +import co.elastic.clients.json.JsonpSerializable; +import co.elastic.clients.json.JsonpUtils; +import co.elastic.clients.json.ObjectBuilderDeserializer; +import co.elastic.clients.json.ObjectDeserializer; +import co.elastic.clients.util.ApiTypeHelper; +import co.elastic.clients.util.ObjectBuilder; +import co.elastic.clients.util.WithJsonObjectBuilderBase; +import jakarta.json.stream.JsonGenerator; +import java.lang.String; +import java.util.Objects; +import java.util.function.Function; +import javax.annotation.Nullable; + +//---------------------------------------------------------------- +// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST. +//---------------------------------------------------------------- +// +// This code is generated from the Elasticsearch API specification +// at https://github.com/elastic/elasticsearch-specification +// +// Manual updates to this file will be lost when the code is +// re-generated. +// +// If you find a property that is missing or wrongly typed, please +// open an issue or a PR on the API specification repository. +// +//---------------------------------------------------------------- + +// typedef: query_rules.test.QueryRulesetMatchedRule + +/** + * + * @see <a href= + * "../../doc-files/api-spec.html#query_rules.test.QueryRulesetMatchedRule">API + * specification</a> + */ +@JsonpDeserializable +public class QueryRulesetMatchedRule implements JsonpSerializable { + private final String rulesetId; + + private final String ruleId; + + // --------------------------------------------------------------------------------------------- + + private QueryRulesetMatchedRule(Builder builder) { + + this.rulesetId = ApiTypeHelper.requireNonNull(builder.rulesetId, this, "rulesetId"); + this.ruleId = ApiTypeHelper.requireNonNull(builder.ruleId, this, "ruleId"); + + } + + public static QueryRulesetMatchedRule of(Function<Builder, ObjectBuilder<QueryRulesetMatchedRule>> fn) { + return fn.apply(new Builder()).build(); + } + + /** + * Required - Ruleset unique identifier + * <p> + * API name: {@code ruleset_id} + */ + public final String rulesetId() { + return this.rulesetId; + } + + /** + * Required - Rule unique identifier within that ruleset + * <p> + * API name: {@code rule_id} + */ + public final String ruleId() { + return this.ruleId; + } + + /** + * Serialize this object to JSON. + */ + public void serialize(JsonGenerator generator, JsonpMapper mapper) { + generator.writeStartObject(); + serializeInternal(generator, mapper); + generator.writeEnd(); + } + + protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) { + + generator.writeKey("ruleset_id"); + generator.write(this.rulesetId); + + generator.writeKey("rule_id"); + generator.write(this.ruleId); + + } + + @Override + public String toString() { + return JsonpUtils.toString(this); + } + + // --------------------------------------------------------------------------------------------- + + /** + * Builder for {@link QueryRulesetMatchedRule}. + */ + + public static class Builder extends WithJsonObjectBuilderBase<Builder> + implements + ObjectBuilder<QueryRulesetMatchedRule> { + private String rulesetId; + + private String ruleId; + + /** + * Required - Ruleset unique identifier + * <p> + * API name: {@code ruleset_id} + */ + public final Builder rulesetId(String value) { + this.rulesetId = value; + return this; + } + + /** + * Required - Rule unique identifier within that ruleset + * <p> + * API name: {@code rule_id} + */ + public final Builder ruleId(String value) { + this.ruleId = value; + return this; + } + + @Override + protected Builder self() { + return this; + } + + /** + * Builds a {@link QueryRulesetMatchedRule}. + * + * @throws NullPointerException + * if some of the required fields are null. + */ + public QueryRulesetMatchedRule build() { + _checkSingleUse(); + + return new QueryRulesetMatchedRule(this); + } + } + + // --------------------------------------------------------------------------------------------- + + /** + * Json deserializer for {@link QueryRulesetMatchedRule} + */ + public static final JsonpDeserializer<QueryRulesetMatchedRule> _DESERIALIZER = ObjectBuilderDeserializer + .lazy(Builder::new, QueryRulesetMatchedRule::setupQueryRulesetMatchedRuleDeserializer); + + protected static void setupQueryRulesetMatchedRuleDeserializer( + ObjectDeserializer<QueryRulesetMatchedRule.Builder> op) { + + op.add(Builder::rulesetId, JsonpDeserializer.stringDeserializer(), "ruleset_id"); + op.add(Builder::ruleId, JsonpDeserializer.stringDeserializer(), "rule_id"); + + } + +} diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/ActivateUserProfileRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/ActivateUserProfileRequest.java index 5003b9e24..dc0bee82b 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/ActivateUserProfileRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/ActivateUserProfileRequest.java @@ -56,7 +56,9 @@ // typedef: security.activate_user_profile.Request /** - * Creates or updates a user profile on behalf of another user. + * Activate a user profile. + * <p> + * Create or update a user profile on behalf of another user. * * @see <a href= * "../doc-files/api-spec.html#security.activate_user_profile.Request">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/AuthenticateRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/AuthenticateRequest.java index f1a8037d5..19e78387f 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/AuthenticateRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/AuthenticateRequest.java @@ -50,8 +50,10 @@ // typedef: security.authenticate.Request /** - * Authenticate a user. Authenticates a user and returns information about the - * authenticated user. Include the user information in a + * Authenticate a user. + * <p> + * Authenticates a user and returns information about the authenticated user. + * Include the user information in a * <a href="https://en.wikipedia.org/wiki/Basic_access_authentication">basic * auth header</a>. A successful call returns a JSON structure that shows user * information such as their username, the roles that are assigned to the user, diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/BulkDeleteRoleRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/BulkDeleteRoleRequest.java index 899040aa4..a580fdbd1 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/BulkDeleteRoleRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/BulkDeleteRoleRequest.java @@ -60,6 +60,8 @@ // typedef: security.bulk_delete_role.Request /** + * Bulk delete roles. + * <p> * The role management APIs are generally the preferred way to manage roles, * rather than using file-based role management. The bulk delete roles API * cannot delete roles that are defined in roles files. diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/BulkPutRoleRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/BulkPutRoleRequest.java index 1dd5efc93..daa4adc2b 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/BulkPutRoleRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/BulkPutRoleRequest.java @@ -59,6 +59,8 @@ // typedef: security.bulk_put_role.Request /** + * Bulk create or update roles. + * <p> * The role management APIs are generally the preferred way to manage roles, * rather than using file-based role management. The bulk create or update roles * API cannot update roles that are defined in roles files. diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/ChangePasswordRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/ChangePasswordRequest.java index 2d29ec47f..d1968a48d 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/ChangePasswordRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/ChangePasswordRequest.java @@ -57,7 +57,9 @@ // typedef: security.change_password.Request /** - * Changes the passwords of users in the native realm and built-in users. + * Change passwords. + * <p> + * Change the passwords of users in the native realm and built-in users. * * @see <a href= * "../doc-files/api-spec.html#security.change_password.Request">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/ClearApiKeyCacheRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/ClearApiKeyCacheRequest.java index 8ebb2f665..b8126ae2c 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/ClearApiKeyCacheRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/ClearApiKeyCacheRequest.java @@ -58,7 +58,9 @@ // typedef: security.clear_api_key_cache.Request /** - * Evicts a subset of all entries from the API key cache. The cache is also + * Clear the API key cache. + * <p> + * Evict a subset of all entries from the API key cache. The cache is also * automatically cleared on state changes of the security index. * * @see <a href= diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/ClearCachedPrivilegesRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/ClearCachedPrivilegesRequest.java index 564f46184..ac95a47a3 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/ClearCachedPrivilegesRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/ClearCachedPrivilegesRequest.java @@ -56,7 +56,11 @@ // typedef: security.clear_cached_privileges.Request /** - * Evicts application privileges from the native application privileges cache. + * Clear the privileges cache. + * <p> + * Evict privileges from the native application privilege cache. The cache is + * also automatically cleared for applications that have their privileges + * updated. * * @see <a href= * "../doc-files/api-spec.html#security.clear_cached_privileges.Request">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/ClearCachedRealmsRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/ClearCachedRealmsRequest.java index 364a2e127..98b7b2420 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/ClearCachedRealmsRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/ClearCachedRealmsRequest.java @@ -57,7 +57,9 @@ // typedef: security.clear_cached_realms.Request /** - * Evicts users from the user cache. Can completely clear the cache or evict + * Clear the user cache. + * <p> + * Evict users from the user cache. You can completely clear the cache or evict * specific users. * * @see <a href= diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/ClearCachedRolesRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/ClearCachedRolesRequest.java index e952d0e3d..41743847c 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/ClearCachedRolesRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/ClearCachedRolesRequest.java @@ -58,7 +58,9 @@ // typedef: security.clear_cached_roles.Request /** - * Evicts roles from the native role cache. + * Clear the roles cache. + * <p> + * Evict roles from the native role cache. * * @see <a href= * "../doc-files/api-spec.html#security.clear_cached_roles.Request">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/ClearCachedServiceTokensRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/ClearCachedServiceTokensRequest.java index 860b496f7..f87bf788a 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/ClearCachedServiceTokensRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/ClearCachedServiceTokensRequest.java @@ -58,7 +58,9 @@ // typedef: security.clear_cached_service_tokens.Request /** - * Evicts tokens from the service account token caches. + * Clear service account token caches. + * <p> + * Evict a subset of all entries from the service account token caches. * * @see <a href= * "../doc-files/api-spec.html#security.clear_cached_service_tokens.Request">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/CreateApiKeyRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/CreateApiKeyRequest.java index c2f678172..6b318ffd5 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/CreateApiKeyRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/CreateApiKeyRequest.java @@ -61,12 +61,13 @@ // typedef: security.create_api_key.Request /** - * Create an API key. Creates an API key for access without requiring basic - * authentication. A successful request returns a JSON structure that contains - * the API key, its unique id, and its name. If applicable, it also returns - * expiration information for the API key in milliseconds. NOTE: By default, API - * keys never expire. You can specify expiration information when you create the - * API keys. + * Create an API key. + * <p> + * Create an API key for access without requiring basic authentication. A + * successful request returns a JSON structure that contains the API key, its + * unique id, and its name. If applicable, it also returns expiration + * information for the API key in milliseconds. NOTE: By default, API keys never + * expire. You can specify expiration information when you create the API keys. * * @see <a href="../doc-files/api-spec.html#security.create_api_key.Request">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/CreateServiceTokenRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/CreateServiceTokenRequest.java index 66a805adf..d0b6ddb29 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/CreateServiceTokenRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/CreateServiceTokenRequest.java @@ -56,7 +56,9 @@ // typedef: security.create_service_token.Request /** - * Creates a service accounts token for access without requiring basic + * Create a service account token. + * <p> + * Create a service accounts token for access without requiring basic * authentication. * * @see <a href= diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/DeletePrivilegesRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/DeletePrivilegesRequest.java index a6aa68581..ea0a65d7f 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/DeletePrivilegesRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/DeletePrivilegesRequest.java @@ -58,7 +58,7 @@ // typedef: security.delete_privileges.Request /** - * Removes application privileges. + * Delete application privileges. * * @see <a href= * "../doc-files/api-spec.html#security.delete_privileges.Request">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/DeleteRoleMappingRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/DeleteRoleMappingRequest.java index e7be6f8e9..b8ec4bf25 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/DeleteRoleMappingRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/DeleteRoleMappingRequest.java @@ -56,7 +56,7 @@ // typedef: security.delete_role_mapping.Request /** - * Removes role mappings. + * Delete role mappings. * * @see <a href= * "../doc-files/api-spec.html#security.delete_role_mapping.Request">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/DeleteRoleRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/DeleteRoleRequest.java index bb507f192..ff4f0ca86 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/DeleteRoleRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/DeleteRoleRequest.java @@ -56,7 +56,9 @@ // typedef: security.delete_role.Request /** - * Removes roles in the native realm. + * Delete roles. + * <p> + * Delete roles in the native realm. * * @see <a href="../doc-files/api-spec.html#security.delete_role.Request">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/DeleteServiceTokenRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/DeleteServiceTokenRequest.java index 472826c6f..16dcca7cb 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/DeleteServiceTokenRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/DeleteServiceTokenRequest.java @@ -56,7 +56,9 @@ // typedef: security.delete_service_token.Request /** - * Deletes a service account token. + * Delete service account tokens. + * <p> + * Delete service account tokens for a service in a specified namespace. * * @see <a href= * "../doc-files/api-spec.html#security.delete_service_token.Request">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/DeleteUserRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/DeleteUserRequest.java index 9b384598f..aaa1f0738 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/DeleteUserRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/DeleteUserRequest.java @@ -56,7 +56,9 @@ // typedef: security.delete_user.Request /** - * Deletes users from the native realm. + * Delete users. + * <p> + * Delete users from the native realm. * * @see <a href="../doc-files/api-spec.html#security.delete_user.Request">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/DisableUserProfileRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/DisableUserProfileRequest.java index e8a5d0e87..f3e6ff021 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/DisableUserProfileRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/DisableUserProfileRequest.java @@ -56,7 +56,9 @@ // typedef: security.disable_user_profile.Request /** - * Disables a user profile so it's not visible in user profile searches. + * Disable a user profile. + * <p> + * Disable user profiles so that they are not visible in user profile searches. * * @see <a href= * "../doc-files/api-spec.html#security.disable_user_profile.Request">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/DisableUserRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/DisableUserRequest.java index 6cb1ab919..b236a270b 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/DisableUserRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/DisableUserRequest.java @@ -56,7 +56,9 @@ // typedef: security.disable_user.Request /** - * Disables users in the native realm. + * Disable users. + * <p> + * Disable users in the native realm. * * @see <a href="../doc-files/api-spec.html#security.disable_user.Request">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/ElasticsearchSecurityAsyncClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/ElasticsearchSecurityAsyncClient.java index 15a98eaad..85cce6e3e 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/ElasticsearchSecurityAsyncClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/ElasticsearchSecurityAsyncClient.java @@ -71,7 +71,9 @@ public ElasticsearchSecurityAsyncClient withTransportOptions(@Nullable Transport // ----- Endpoint: security.activate_user_profile /** - * Creates or updates a user profile on behalf of another user. + * Activate a user profile. + * <p> + * Create or update a user profile on behalf of another user. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-activate-user-profile.html">Documentation @@ -86,7 +88,9 @@ public CompletableFuture<ActivateUserProfileResponse> activateUserProfile(Activa } /** - * Creates or updates a user profile on behalf of another user. + * Activate a user profile. + * <p> + * Create or update a user profile on behalf of another user. * * @param fn * a function that initializes a builder to create the @@ -104,8 +108,10 @@ public final CompletableFuture<ActivateUserProfileResponse> activateUserProfile( // ----- Endpoint: security.authenticate /** - * Authenticate a user. Authenticates a user and returns information about the - * authenticated user. Include the user information in a + * Authenticate a user. + * <p> + * Authenticates a user and returns information about the authenticated user. + * Include the user information in a * <a href="https://en.wikipedia.org/wiki/Basic_access_authentication">basic * auth header</a>. A successful call returns a JSON structure that shows user * information such as their username, the roles that are assigned to the user, @@ -125,6 +131,8 @@ public CompletableFuture<AuthenticateResponse> authenticate() { // ----- Endpoint: security.bulk_delete_role /** + * Bulk delete roles. + * <p> * The role management APIs are generally the preferred way to manage roles, * rather than using file-based role management. The bulk delete roles API * cannot delete roles that are defined in roles files. @@ -142,6 +150,8 @@ public CompletableFuture<BulkDeleteRoleResponse> bulkDeleteRole(BulkDeleteRoleRe } /** + * Bulk delete roles. + * <p> * The role management APIs are generally the preferred way to manage roles, * rather than using file-based role management. The bulk delete roles API * cannot delete roles that are defined in roles files. @@ -162,6 +172,8 @@ public final CompletableFuture<BulkDeleteRoleResponse> bulkDeleteRole( // ----- Endpoint: security.bulk_put_role /** + * Bulk create or update roles. + * <p> * The role management APIs are generally the preferred way to manage roles, * rather than using file-based role management. The bulk create or update roles * API cannot update roles that are defined in roles files. @@ -179,6 +191,8 @@ public CompletableFuture<BulkPutRoleResponse> bulkPutRole(BulkPutRoleRequest req } /** + * Bulk create or update roles. + * <p> * The role management APIs are generally the preferred way to manage roles, * rather than using file-based role management. The bulk create or update roles * API cannot update roles that are defined in roles files. @@ -199,7 +213,9 @@ public final CompletableFuture<BulkPutRoleResponse> bulkPutRole( // ----- Endpoint: security.change_password /** - * Changes the passwords of users in the native realm and built-in users. + * Change passwords. + * <p> + * Change the passwords of users in the native realm and built-in users. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-change-password.html">Documentation @@ -214,7 +230,9 @@ public CompletableFuture<ChangePasswordResponse> changePassword(ChangePasswordRe } /** - * Changes the passwords of users in the native realm and built-in users. + * Change passwords. + * <p> + * Change the passwords of users in the native realm and built-in users. * * @param fn * a function that initializes a builder to create the @@ -230,7 +248,9 @@ public final CompletableFuture<ChangePasswordResponse> changePassword( } /** - * Changes the passwords of users in the native realm and built-in users. + * Change passwords. + * <p> + * Change the passwords of users in the native realm and built-in users. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-change-password.html">Documentation @@ -245,7 +265,9 @@ public CompletableFuture<ChangePasswordResponse> changePassword() { // ----- Endpoint: security.clear_api_key_cache /** - * Evicts a subset of all entries from the API key cache. The cache is also + * Clear the API key cache. + * <p> + * Evict a subset of all entries from the API key cache. The cache is also * automatically cleared on state changes of the security index. * * @see <a href= @@ -261,7 +283,9 @@ public CompletableFuture<ClearApiKeyCacheResponse> clearApiKeyCache(ClearApiKeyC } /** - * Evicts a subset of all entries from the API key cache. The cache is also + * Clear the API key cache. + * <p> + * Evict a subset of all entries from the API key cache. The cache is also * automatically cleared on state changes of the security index. * * @param fn @@ -280,7 +304,11 @@ public final CompletableFuture<ClearApiKeyCacheResponse> clearApiKeyCache( // ----- Endpoint: security.clear_cached_privileges /** - * Evicts application privileges from the native application privileges cache. + * Clear the privileges cache. + * <p> + * Evict privileges from the native application privilege cache. The cache is + * also automatically cleared for applications that have their privileges + * updated. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-privilege-cache.html">Documentation @@ -296,7 +324,11 @@ public CompletableFuture<ClearCachedPrivilegesResponse> clearCachedPrivileges( } /** - * Evicts application privileges from the native application privileges cache. + * Clear the privileges cache. + * <p> + * Evict privileges from the native application privilege cache. The cache is + * also automatically cleared for applications that have their privileges + * updated. * * @param fn * a function that initializes a builder to create the @@ -314,7 +346,9 @@ public final CompletableFuture<ClearCachedPrivilegesResponse> clearCachedPrivile // ----- Endpoint: security.clear_cached_realms /** - * Evicts users from the user cache. Can completely clear the cache or evict + * Clear the user cache. + * <p> + * Evict users from the user cache. You can completely clear the cache or evict * specific users. * * @see <a href= @@ -330,7 +364,9 @@ public CompletableFuture<ClearCachedRealmsResponse> clearCachedRealms(ClearCache } /** - * Evicts users from the user cache. Can completely clear the cache or evict + * Clear the user cache. + * <p> + * Evict users from the user cache. You can completely clear the cache or evict * specific users. * * @param fn @@ -349,7 +385,9 @@ public final CompletableFuture<ClearCachedRealmsResponse> clearCachedRealms( // ----- Endpoint: security.clear_cached_roles /** - * Evicts roles from the native role cache. + * Clear the roles cache. + * <p> + * Evict roles from the native role cache. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-role-cache.html">Documentation @@ -364,7 +402,9 @@ public CompletableFuture<ClearCachedRolesResponse> clearCachedRoles(ClearCachedR } /** - * Evicts roles from the native role cache. + * Clear the roles cache. + * <p> + * Evict roles from the native role cache. * * @param fn * a function that initializes a builder to create the @@ -382,7 +422,9 @@ public final CompletableFuture<ClearCachedRolesResponse> clearCachedRoles( // ----- Endpoint: security.clear_cached_service_tokens /** - * Evicts tokens from the service account token caches. + * Clear service account token caches. + * <p> + * Evict a subset of all entries from the service account token caches. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-service-token-caches.html">Documentation @@ -398,7 +440,9 @@ public CompletableFuture<ClearCachedServiceTokensResponse> clearCachedServiceTok } /** - * Evicts tokens from the service account token caches. + * Clear service account token caches. + * <p> + * Evict a subset of all entries from the service account token caches. * * @param fn * a function that initializes a builder to create the @@ -416,12 +460,13 @@ public final CompletableFuture<ClearCachedServiceTokensResponse> clearCachedServ // ----- Endpoint: security.create_api_key /** - * Create an API key. Creates an API key for access without requiring basic - * authentication. A successful request returns a JSON structure that contains - * the API key, its unique id, and its name. If applicable, it also returns - * expiration information for the API key in milliseconds. NOTE: By default, API - * keys never expire. You can specify expiration information when you create the - * API keys. + * Create an API key. + * <p> + * Create an API key for access without requiring basic authentication. A + * successful request returns a JSON structure that contains the API key, its + * unique id, and its name. If applicable, it also returns expiration + * information for the API key in milliseconds. NOTE: By default, API keys never + * expire. You can specify expiration information when you create the API keys. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html">Documentation @@ -436,12 +481,13 @@ public CompletableFuture<CreateApiKeyResponse> createApiKey(CreateApiKeyRequest } /** - * Create an API key. Creates an API key for access without requiring basic - * authentication. A successful request returns a JSON structure that contains - * the API key, its unique id, and its name. If applicable, it also returns - * expiration information for the API key in milliseconds. NOTE: By default, API - * keys never expire. You can specify expiration information when you create the - * API keys. + * Create an API key. + * <p> + * Create an API key for access without requiring basic authentication. A + * successful request returns a JSON structure that contains the API key, its + * unique id, and its name. If applicable, it also returns expiration + * information for the API key in milliseconds. NOTE: By default, API keys never + * expire. You can specify expiration information when you create the API keys. * * @param fn * a function that initializes a builder to create the @@ -457,12 +503,13 @@ public final CompletableFuture<CreateApiKeyResponse> createApiKey( } /** - * Create an API key. Creates an API key for access without requiring basic - * authentication. A successful request returns a JSON structure that contains - * the API key, its unique id, and its name. If applicable, it also returns - * expiration information for the API key in milliseconds. NOTE: By default, API - * keys never expire. You can specify expiration information when you create the - * API keys. + * Create an API key. + * <p> + * Create an API key for access without requiring basic authentication. A + * successful request returns a JSON structure that contains the API key, its + * unique id, and its name. If applicable, it also returns expiration + * information for the API key in milliseconds. NOTE: By default, API keys never + * expire. You can specify expiration information when you create the API keys. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html">Documentation @@ -477,7 +524,9 @@ public CompletableFuture<CreateApiKeyResponse> createApiKey() { // ----- Endpoint: security.create_service_token /** - * Creates a service accounts token for access without requiring basic + * Create a service account token. + * <p> + * Create a service accounts token for access without requiring basic * authentication. * * @see <a href= @@ -493,7 +542,9 @@ public CompletableFuture<CreateServiceTokenResponse> createServiceToken(CreateSe } /** - * Creates a service accounts token for access without requiring basic + * Create a service account token. + * <p> + * Create a service accounts token for access without requiring basic * authentication. * * @param fn @@ -512,7 +563,7 @@ public final CompletableFuture<CreateServiceTokenResponse> createServiceToken( // ----- Endpoint: security.delete_privileges /** - * Removes application privileges. + * Delete application privileges. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-privilege.html">Documentation @@ -527,7 +578,7 @@ public CompletableFuture<DeletePrivilegesResponse> deletePrivileges(DeletePrivil } /** - * Removes application privileges. + * Delete application privileges. * * @param fn * a function that initializes a builder to create the @@ -545,7 +596,9 @@ public final CompletableFuture<DeletePrivilegesResponse> deletePrivileges( // ----- Endpoint: security.delete_role /** - * Removes roles in the native realm. + * Delete roles. + * <p> + * Delete roles in the native realm. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role.html">Documentation @@ -560,7 +613,9 @@ public CompletableFuture<DeleteRoleResponse> deleteRole(DeleteRoleRequest reques } /** - * Removes roles in the native realm. + * Delete roles. + * <p> + * Delete roles in the native realm. * * @param fn * a function that initializes a builder to create the @@ -578,7 +633,7 @@ public final CompletableFuture<DeleteRoleResponse> deleteRole( // ----- Endpoint: security.delete_role_mapping /** - * Removes role mappings. + * Delete role mappings. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role-mapping.html">Documentation @@ -593,7 +648,7 @@ public CompletableFuture<DeleteRoleMappingResponse> deleteRoleMapping(DeleteRole } /** - * Removes role mappings. + * Delete role mappings. * * @param fn * a function that initializes a builder to create the @@ -611,7 +666,9 @@ public final CompletableFuture<DeleteRoleMappingResponse> deleteRoleMapping( // ----- Endpoint: security.delete_service_token /** - * Deletes a service account token. + * Delete service account tokens. + * <p> + * Delete service account tokens for a service in a specified namespace. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-service-token.html">Documentation @@ -626,7 +683,9 @@ public CompletableFuture<DeleteServiceTokenResponse> deleteServiceToken(DeleteSe } /** - * Deletes a service account token. + * Delete service account tokens. + * <p> + * Delete service account tokens for a service in a specified namespace. * * @param fn * a function that initializes a builder to create the @@ -644,7 +703,9 @@ public final CompletableFuture<DeleteServiceTokenResponse> deleteServiceToken( // ----- Endpoint: security.delete_user /** - * Deletes users from the native realm. + * Delete users. + * <p> + * Delete users from the native realm. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-user.html">Documentation @@ -659,7 +720,9 @@ public CompletableFuture<DeleteUserResponse> deleteUser(DeleteUserRequest reques } /** - * Deletes users from the native realm. + * Delete users. + * <p> + * Delete users from the native realm. * * @param fn * a function that initializes a builder to create the @@ -677,7 +740,9 @@ public final CompletableFuture<DeleteUserResponse> deleteUser( // ----- Endpoint: security.disable_user /** - * Disables users in the native realm. + * Disable users. + * <p> + * Disable users in the native realm. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-disable-user.html">Documentation @@ -692,7 +757,9 @@ public CompletableFuture<DisableUserResponse> disableUser(DisableUserRequest req } /** - * Disables users in the native realm. + * Disable users. + * <p> + * Disable users in the native realm. * * @param fn * a function that initializes a builder to create the @@ -710,7 +777,9 @@ public final CompletableFuture<DisableUserResponse> disableUser( // ----- Endpoint: security.disable_user_profile /** - * Disables a user profile so it's not visible in user profile searches. + * Disable a user profile. + * <p> + * Disable user profiles so that they are not visible in user profile searches. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-disable-user-profile.html">Documentation @@ -725,7 +794,9 @@ public CompletableFuture<DisableUserProfileResponse> disableUserProfile(DisableU } /** - * Disables a user profile so it's not visible in user profile searches. + * Disable a user profile. + * <p> + * Disable user profiles so that they are not visible in user profile searches. * * @param fn * a function that initializes a builder to create the @@ -743,7 +814,9 @@ public final CompletableFuture<DisableUserProfileResponse> disableUserProfile( // ----- Endpoint: security.enable_user /** - * Enables users in the native realm. + * Enable users. + * <p> + * Enable users in the native realm. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-enable-user.html">Documentation @@ -758,7 +831,9 @@ public CompletableFuture<EnableUserResponse> enableUser(EnableUserRequest reques } /** - * Enables users in the native realm. + * Enable users. + * <p> + * Enable users in the native realm. * * @param fn * a function that initializes a builder to create the @@ -776,7 +851,9 @@ public final CompletableFuture<EnableUserResponse> enableUser( // ----- Endpoint: security.enable_user_profile /** - * Enables a user profile so it's visible in user profile searches. + * Enable a user profile. + * <p> + * Enable user profiles to make them visible in user profile searches. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-enable-user-profile.html">Documentation @@ -791,7 +868,9 @@ public CompletableFuture<EnableUserProfileResponse> enableUserProfile(EnableUser } /** - * Enables a user profile so it's visible in user profile searches. + * Enable a user profile. + * <p> + * Enable user profiles to make them visible in user profile searches. * * @param fn * a function that initializes a builder to create the @@ -809,8 +888,10 @@ public final CompletableFuture<EnableUserProfileResponse> enableUserProfile( // ----- Endpoint: security.enroll_kibana /** - * Enables a Kibana instance to configure itself for communication with a - * secured Elasticsearch cluster. + * Enroll Kibana. + * <p> + * Enable a Kibana instance to configure itself for communication with a secured + * Elasticsearch cluster. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-kibana-enrollment.html">Documentation @@ -824,7 +905,10 @@ public CompletableFuture<EnrollKibanaResponse> enrollKibana() { // ----- Endpoint: security.enroll_node /** - * Allows a new node to join an existing cluster with security features enabled. + * Enroll a node. + * <p> + * Enroll a new node to allow it to join an existing cluster with security + * features enabled. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-node-enrollment.html">Documentation @@ -838,12 +922,14 @@ public CompletableFuture<EnrollNodeResponse> enrollNode() { // ----- Endpoint: security.get_api_key /** - * Get API key information. Retrieves information for one or more API keys. - * NOTE: If you have only the <code>manage_own_api_key</code> privilege, this - * API returns only the API keys that you own. If you have - * <code>read_security</code>, <code>manage_api_key</code> or greater privileges - * (including <code>manage_security</code>), this API returns all API keys - * regardless of ownership. + * Get API key information. + * <p> + * Retrieves information for one or more API keys. NOTE: If you have only the + * <code>manage_own_api_key</code> privilege, this API returns only the API keys + * that you own. If you have <code>read_security</code>, + * <code>manage_api_key</code> or greater privileges (including + * <code>manage_security</code>), this API returns all API keys regardless of + * ownership. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html">Documentation @@ -858,12 +944,14 @@ public CompletableFuture<GetApiKeyResponse> getApiKey(GetApiKeyRequest request) } /** - * Get API key information. Retrieves information for one or more API keys. - * NOTE: If you have only the <code>manage_own_api_key</code> privilege, this - * API returns only the API keys that you own. If you have - * <code>read_security</code>, <code>manage_api_key</code> or greater privileges - * (including <code>manage_security</code>), this API returns all API keys - * regardless of ownership. + * Get API key information. + * <p> + * Retrieves information for one or more API keys. NOTE: If you have only the + * <code>manage_own_api_key</code> privilege, this API returns only the API keys + * that you own. If you have <code>read_security</code>, + * <code>manage_api_key</code> or greater privileges (including + * <code>manage_security</code>), this API returns all API keys regardless of + * ownership. * * @param fn * a function that initializes a builder to create the @@ -879,12 +967,14 @@ public final CompletableFuture<GetApiKeyResponse> getApiKey( } /** - * Get API key information. Retrieves information for one or more API keys. - * NOTE: If you have only the <code>manage_own_api_key</code> privilege, this - * API returns only the API keys that you own. If you have - * <code>read_security</code>, <code>manage_api_key</code> or greater privileges - * (including <code>manage_security</code>), this API returns all API keys - * regardless of ownership. + * Get API key information. + * <p> + * Retrieves information for one or more API keys. NOTE: If you have only the + * <code>manage_own_api_key</code> privilege, this API returns only the API keys + * that you own. If you have <code>read_security</code>, + * <code>manage_api_key</code> or greater privileges (including + * <code>manage_security</code>), this API returns all API keys regardless of + * ownership. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html">Documentation @@ -899,8 +989,10 @@ public CompletableFuture<GetApiKeyResponse> getApiKey() { // ----- Endpoint: security.get_builtin_privileges /** - * Retrieves the list of cluster privileges and index privileges that are - * available in this version of Elasticsearch. + * Get builtin privileges. + * <p> + * Get the list of cluster privileges and index privileges that are available in + * this version of Elasticsearch. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-builtin-privileges.html">Documentation @@ -914,7 +1006,7 @@ public CompletableFuture<GetBuiltinPrivilegesResponse> getBuiltinPrivileges() { // ----- Endpoint: security.get_privileges /** - * Retrieves application privileges. + * Get application privileges. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-privileges.html">Documentation @@ -929,7 +1021,7 @@ public CompletableFuture<GetPrivilegesResponse> getPrivileges(GetPrivilegesReque } /** - * Retrieves application privileges. + * Get application privileges. * * @param fn * a function that initializes a builder to create the @@ -945,7 +1037,7 @@ public final CompletableFuture<GetPrivilegesResponse> getPrivileges( } /** - * Retrieves application privileges. + * Get application privileges. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-privileges.html">Documentation @@ -960,9 +1052,11 @@ public CompletableFuture<GetPrivilegesResponse> getPrivileges() { // ----- Endpoint: security.get_role /** - * The role management APIs are generally the preferred way to manage roles, - * rather than using file-based role management. The get roles API cannot - * retrieve roles that are defined in roles files. + * Get roles. + * <p> + * Get roles in the native realm. The role management APIs are generally the + * preferred way to manage roles, rather than using file-based role management. + * The get roles API cannot retrieve roles that are defined in roles files. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html">Documentation @@ -977,9 +1071,11 @@ public CompletableFuture<GetRoleResponse> getRole(GetRoleRequest request) { } /** - * The role management APIs are generally the preferred way to manage roles, - * rather than using file-based role management. The get roles API cannot - * retrieve roles that are defined in roles files. + * Get roles. + * <p> + * Get roles in the native realm. The role management APIs are generally the + * preferred way to manage roles, rather than using file-based role management. + * The get roles API cannot retrieve roles that are defined in roles files. * * @param fn * a function that initializes a builder to create the @@ -995,9 +1091,11 @@ public final CompletableFuture<GetRoleResponse> getRole( } /** - * The role management APIs are generally the preferred way to manage roles, - * rather than using file-based role management. The get roles API cannot - * retrieve roles that are defined in roles files. + * Get roles. + * <p> + * Get roles in the native realm. The role management APIs are generally the + * preferred way to manage roles, rather than using file-based role management. + * The get roles API cannot retrieve roles that are defined in roles files. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html">Documentation @@ -1012,7 +1110,12 @@ public CompletableFuture<GetRoleResponse> getRole() { // ----- Endpoint: security.get_role_mapping /** - * Retrieves role mappings. + * Get role mappings. + * <p> + * Role mappings define which roles are assigned to each user. The role mapping + * APIs are generally the preferred way to manage role mappings rather than + * using role mapping files. The get role mappings API cannot retrieve role + * mappings that are defined in role mapping files. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role-mapping.html">Documentation @@ -1027,7 +1130,12 @@ public CompletableFuture<GetRoleMappingResponse> getRoleMapping(GetRoleMappingRe } /** - * Retrieves role mappings. + * Get role mappings. + * <p> + * Role mappings define which roles are assigned to each user. The role mapping + * APIs are generally the preferred way to manage role mappings rather than + * using role mapping files. The get role mappings API cannot retrieve role + * mappings that are defined in role mapping files. * * @param fn * a function that initializes a builder to create the @@ -1043,7 +1151,12 @@ public final CompletableFuture<GetRoleMappingResponse> getRoleMapping( } /** - * Retrieves role mappings. + * Get role mappings. + * <p> + * Role mappings define which roles are assigned to each user. The role mapping + * APIs are generally the preferred way to manage role mappings rather than + * using role mapping files. The get role mappings API cannot retrieve role + * mappings that are defined in role mapping files. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role-mapping.html">Documentation @@ -1058,8 +1171,9 @@ public CompletableFuture<GetRoleMappingResponse> getRoleMapping() { // ----- Endpoint: security.get_service_accounts /** - * This API returns a list of service accounts that match the provided path - * parameter(s). + * Get service accounts. + * <p> + * Get a list of service accounts that match the provided path parameters. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-accounts.html">Documentation @@ -1074,8 +1188,9 @@ public CompletableFuture<GetServiceAccountsResponse> getServiceAccounts(GetServi } /** - * This API returns a list of service accounts that match the provided path - * parameter(s). + * Get service accounts. + * <p> + * Get a list of service accounts that match the provided path parameters. * * @param fn * a function that initializes a builder to create the @@ -1091,8 +1206,9 @@ public final CompletableFuture<GetServiceAccountsResponse> getServiceAccounts( } /** - * This API returns a list of service accounts that match the provided path - * parameter(s). + * Get service accounts. + * <p> + * Get a list of service accounts that match the provided path parameters. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-accounts.html">Documentation @@ -1107,7 +1223,7 @@ public CompletableFuture<GetServiceAccountsResponse> getServiceAccounts() { // ----- Endpoint: security.get_service_credentials /** - * Retrieves information of all service credentials for a service account. + * Get service account credentials. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-credentials.html">Documentation @@ -1123,7 +1239,7 @@ public CompletableFuture<GetServiceCredentialsResponse> getServiceCredentials( } /** - * Retrieves information of all service credentials for a service account. + * Get service account credentials. * * @param fn * a function that initializes a builder to create the @@ -1141,7 +1257,9 @@ public final CompletableFuture<GetServiceCredentialsResponse> getServiceCredenti // ----- Endpoint: security.get_token /** - * Creates a bearer token for access without requiring basic authentication. + * Get a token. + * <p> + * Create a bearer token for access without requiring basic authentication. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-token.html">Documentation @@ -1156,7 +1274,9 @@ public CompletableFuture<GetTokenResponse> getToken(GetTokenRequest request) { } /** - * Creates a bearer token for access without requiring basic authentication. + * Get a token. + * <p> + * Create a bearer token for access without requiring basic authentication. * * @param fn * a function that initializes a builder to create the @@ -1172,7 +1292,9 @@ public final CompletableFuture<GetTokenResponse> getToken( } /** - * Creates a bearer token for access without requiring basic authentication. + * Get a token. + * <p> + * Create a bearer token for access without requiring basic authentication. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-token.html">Documentation @@ -1187,7 +1309,9 @@ public CompletableFuture<GetTokenResponse> getToken() { // ----- Endpoint: security.get_user /** - * Retrieves information about users in the native realm and built-in users. + * Get users. + * <p> + * Get information about users in the native realm and built-in users. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user.html">Documentation @@ -1202,7 +1326,9 @@ public CompletableFuture<GetUserResponse> getUser(GetUserRequest request) { } /** - * Retrieves information about users in the native realm and built-in users. + * Get users. + * <p> + * Get information about users in the native realm and built-in users. * * @param fn * a function that initializes a builder to create the @@ -1218,7 +1344,9 @@ public final CompletableFuture<GetUserResponse> getUser( } /** - * Retrieves information about users in the native realm and built-in users. + * Get users. + * <p> + * Get information about users in the native realm and built-in users. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user.html">Documentation @@ -1233,7 +1361,7 @@ public CompletableFuture<GetUserResponse> getUser() { // ----- Endpoint: security.get_user_privileges /** - * Retrieves security privileges for the logged in user. + * Get user privileges. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user-privileges.html">Documentation @@ -1248,7 +1376,7 @@ public CompletableFuture<GetUserPrivilegesResponse> getUserPrivileges(GetUserPri } /** - * Retrieves security privileges for the logged in user. + * Get user privileges. * * @param fn * a function that initializes a builder to create the @@ -1264,7 +1392,7 @@ public final CompletableFuture<GetUserPrivilegesResponse> getUserPrivileges( } /** - * Retrieves security privileges for the logged in user. + * Get user privileges. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user-privileges.html">Documentation @@ -1279,7 +1407,9 @@ public CompletableFuture<GetUserPrivilegesResponse> getUserPrivileges() { // ----- Endpoint: security.get_user_profile /** - * Retrieves a user's profile using the unique profile ID. + * Get a user profile. + * <p> + * Get a user's profile using the unique profile ID. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user-profile.html">Documentation @@ -1294,7 +1424,9 @@ public CompletableFuture<GetUserProfileResponse> getUserProfile(GetUserProfileRe } /** - * Retrieves a user's profile using the unique profile ID. + * Get a user profile. + * <p> + * Get a user's profile using the unique profile ID. * * @param fn * a function that initializes a builder to create the @@ -1312,15 +1444,17 @@ public final CompletableFuture<GetUserProfileResponse> getUserProfile( // ----- Endpoint: security.grant_api_key /** - * Creates an API key on behalf of another user. This API is similar to Create - * API keys, however it creates the API key for a user that is different than - * the user that runs the API. The caller must have authentication credentials - * (either an access token, or a username and password) for the user on whose - * behalf the API key will be created. It is not possible to use this API to - * create an API key without that user’s credentials. The user, for whom the - * authentication credentials is provided, can optionally "run as" - * (impersonate) another user. In this case, the API key will be created on - * behalf of the impersonated user. + * Grant an API key. + * <p> + * Create an API key on behalf of another user. This API is similar to the + * create API keys API, however it creates the API key for a user that is + * different than the user that runs the API. The caller must have + * authentication credentials (either an access token, or a username and + * password) for the user on whose behalf the API key will be created. It is not + * possible to use this API to create an API key without that user’s + * credentials. The user, for whom the authentication credentials is provided, + * can optionally "run as" (impersonate) another user. In this case, + * the API key will be created on behalf of the impersonated user. * <p> * This API is intended be used by applications that need to create and manage * API keys for end users, but cannot guarantee that those users have permission @@ -1346,15 +1480,17 @@ public CompletableFuture<GrantApiKeyResponse> grantApiKey(GrantApiKeyRequest req } /** - * Creates an API key on behalf of another user. This API is similar to Create - * API keys, however it creates the API key for a user that is different than - * the user that runs the API. The caller must have authentication credentials - * (either an access token, or a username and password) for the user on whose - * behalf the API key will be created. It is not possible to use this API to - * create an API key without that user’s credentials. The user, for whom the - * authentication credentials is provided, can optionally "run as" - * (impersonate) another user. In this case, the API key will be created on - * behalf of the impersonated user. + * Grant an API key. + * <p> + * Create an API key on behalf of another user. This API is similar to the + * create API keys API, however it creates the API key for a user that is + * different than the user that runs the API. The caller must have + * authentication credentials (either an access token, or a username and + * password) for the user on whose behalf the API key will be created. It is not + * possible to use this API to create an API key without that user’s + * credentials. The user, for whom the authentication credentials is provided, + * can optionally "run as" (impersonate) another user. In this case, + * the API key will be created on behalf of the impersonated user. * <p> * This API is intended be used by applications that need to create and manage * API keys for end users, but cannot guarantee that those users have permission @@ -1383,8 +1519,9 @@ public final CompletableFuture<GrantApiKeyResponse> grantApiKey( // ----- Endpoint: security.has_privileges /** - * Check user privileges. Determines whether the specified user has a specified - * list of privileges. + * Check user privileges. + * <p> + * Determine whether the specified user has a specified list of privileges. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html">Documentation @@ -1399,8 +1536,9 @@ public CompletableFuture<HasPrivilegesResponse> hasPrivileges(HasPrivilegesReque } /** - * Check user privileges. Determines whether the specified user has a specified - * list of privileges. + * Check user privileges. + * <p> + * Determine whether the specified user has a specified list of privileges. * * @param fn * a function that initializes a builder to create the @@ -1416,8 +1554,9 @@ public final CompletableFuture<HasPrivilegesResponse> hasPrivileges( } /** - * Check user privileges. Determines whether the specified user has a specified - * list of privileges. + * Check user privileges. + * <p> + * Determine whether the specified user has a specified list of privileges. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html">Documentation @@ -1432,8 +1571,10 @@ public CompletableFuture<HasPrivilegesResponse> hasPrivileges() { // ----- Endpoint: security.has_privileges_user_profile /** - * Determines whether the users associated with the specified profile IDs have - * all the requested privileges. + * Check user profile privileges. + * <p> + * Determine whether the users associated with the specified user profile IDs + * have all the requested privileges. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges-user-profile.html">Documentation @@ -1449,8 +1590,10 @@ public CompletableFuture<HasPrivilegesUserProfileResponse> hasPrivilegesUserProf } /** - * Determines whether the users associated with the specified profile IDs have - * all the requested privileges. + * Check user profile privileges. + * <p> + * Determine whether the users associated with the specified user profile IDs + * have all the requested privileges. * * @param fn * a function that initializes a builder to create the @@ -1468,8 +1611,13 @@ public final CompletableFuture<HasPrivilegesUserProfileResponse> hasPrivilegesUs // ----- Endpoint: security.invalidate_api_key /** - * Invalidate API keys. Invalidates one or more API keys. The - * <code>manage_api_key</code> privilege allows deleting any API keys. The + * Invalidate API keys. + * <p> + * This API invalidates API keys created by the create API key or grant API key + * APIs. Invalidated API keys fail authentication, but they can still be viewed + * using the get API key information and query API key information APIs, for at + * least the configured retention period, until they are automatically deleted. + * The <code>manage_api_key</code> privilege allows deleting any API keys. The * <code>manage_own_api_key</code> only allows deleting API keys that are owned * by the user. In addition, with the <code>manage_own_api_key</code> privilege, * an invalidation request must be issued in one of the three formats: @@ -1477,8 +1625,8 @@ public final CompletableFuture<HasPrivilegesUserProfileResponse> hasPrivilegesUs * <li>Set the parameter <code>owner=true</code>.</li> * <li>Or, set both <code>username</code> and <code>realm_name</code> to match * the user’s identity.</li> - * <li>Or, if the request is issued by an API key, i.e. an API key invalidates - * itself, specify its ID in the <code>ids</code> field.</li> + * <li>Or, if the request is issued by an API key, that is to say an API key + * invalidates itself, specify its ID in the <code>ids</code> field.</li> * </ul> * * @see <a href= @@ -1494,8 +1642,13 @@ public CompletableFuture<InvalidateApiKeyResponse> invalidateApiKey(InvalidateAp } /** - * Invalidate API keys. Invalidates one or more API keys. The - * <code>manage_api_key</code> privilege allows deleting any API keys. The + * Invalidate API keys. + * <p> + * This API invalidates API keys created by the create API key or grant API key + * APIs. Invalidated API keys fail authentication, but they can still be viewed + * using the get API key information and query API key information APIs, for at + * least the configured retention period, until they are automatically deleted. + * The <code>manage_api_key</code> privilege allows deleting any API keys. The * <code>manage_own_api_key</code> only allows deleting API keys that are owned * by the user. In addition, with the <code>manage_own_api_key</code> privilege, * an invalidation request must be issued in one of the three formats: @@ -1503,8 +1656,8 @@ public CompletableFuture<InvalidateApiKeyResponse> invalidateApiKey(InvalidateAp * <li>Set the parameter <code>owner=true</code>.</li> * <li>Or, set both <code>username</code> and <code>realm_name</code> to match * the user’s identity.</li> - * <li>Or, if the request is issued by an API key, i.e. an API key invalidates - * itself, specify its ID in the <code>ids</code> field.</li> + * <li>Or, if the request is issued by an API key, that is to say an API key + * invalidates itself, specify its ID in the <code>ids</code> field.</li> * </ul> * * @param fn @@ -1521,8 +1674,13 @@ public final CompletableFuture<InvalidateApiKeyResponse> invalidateApiKey( } /** - * Invalidate API keys. Invalidates one or more API keys. The - * <code>manage_api_key</code> privilege allows deleting any API keys. The + * Invalidate API keys. + * <p> + * This API invalidates API keys created by the create API key or grant API key + * APIs. Invalidated API keys fail authentication, but they can still be viewed + * using the get API key information and query API key information APIs, for at + * least the configured retention period, until they are automatically deleted. + * The <code>manage_api_key</code> privilege allows deleting any API keys. The * <code>manage_own_api_key</code> only allows deleting API keys that are owned * by the user. In addition, with the <code>manage_own_api_key</code> privilege, * an invalidation request must be issued in one of the three formats: @@ -1530,8 +1688,8 @@ public final CompletableFuture<InvalidateApiKeyResponse> invalidateApiKey( * <li>Set the parameter <code>owner=true</code>.</li> * <li>Or, set both <code>username</code> and <code>realm_name</code> to match * the user’s identity.</li> - * <li>Or, if the request is issued by an API key, i.e. an API key invalidates - * itself, specify its ID in the <code>ids</code> field.</li> + * <li>Or, if the request is issued by an API key, that is to say an API key + * invalidates itself, specify its ID in the <code>ids</code> field.</li> * </ul> * * @see <a href= @@ -1547,7 +1705,16 @@ public CompletableFuture<InvalidateApiKeyResponse> invalidateApiKey() { // ----- Endpoint: security.invalidate_token /** - * Invalidates one or more access tokens or refresh tokens. + * Invalidate a token. + * <p> + * The access tokens returned by the get token API have a finite period of time + * for which they are valid. After that time period, they can no longer be used. + * The time period is defined by the + * <code>xpack.security.authc.token.timeout</code> setting. + * <p> + * The refresh tokens returned by the get token API are only valid for 24 hours. + * They can also be used exactly once. If you want to invalidate one or more + * access or refresh tokens immediately, use this invalidate token API. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-token.html">Documentation @@ -1562,7 +1729,16 @@ public CompletableFuture<InvalidateTokenResponse> invalidateToken(InvalidateToke } /** - * Invalidates one or more access tokens or refresh tokens. + * Invalidate a token. + * <p> + * The access tokens returned by the get token API have a finite period of time + * for which they are valid. After that time period, they can no longer be used. + * The time period is defined by the + * <code>xpack.security.authc.token.timeout</code> setting. + * <p> + * The refresh tokens returned by the get token API are only valid for 24 hours. + * They can also be used exactly once. If you want to invalidate one or more + * access or refresh tokens immediately, use this invalidate token API. * * @param fn * a function that initializes a builder to create the @@ -1578,7 +1754,16 @@ public final CompletableFuture<InvalidateTokenResponse> invalidateToken( } /** - * Invalidates one or more access tokens or refresh tokens. + * Invalidate a token. + * <p> + * The access tokens returned by the get token API have a finite period of time + * for which they are valid. After that time period, they can no longer be used. + * The time period is defined by the + * <code>xpack.security.authc.token.timeout</code> setting. + * <p> + * The refresh tokens returned by the get token API are only valid for 24 hours. + * They can also be used exactly once. If you want to invalidate one or more + * access or refresh tokens immediately, use this invalidate token API. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-token.html">Documentation @@ -1593,7 +1778,7 @@ public CompletableFuture<InvalidateTokenResponse> invalidateToken() { // ----- Endpoint: security.put_privileges /** - * Adds or updates application privileges. + * Create or update application privileges. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-privileges.html">Documentation @@ -1608,7 +1793,7 @@ public CompletableFuture<PutPrivilegesResponse> putPrivileges(PutPrivilegesReque } /** - * Adds or updates application privileges. + * Create or update application privileges. * * @param fn * a function that initializes a builder to create the @@ -1624,7 +1809,7 @@ public final CompletableFuture<PutPrivilegesResponse> putPrivileges( } /** - * Adds or updates application privileges. + * Create or update application privileges. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-privileges.html">Documentation @@ -1639,9 +1824,12 @@ public CompletableFuture<PutPrivilegesResponse> putPrivileges() { // ----- Endpoint: security.put_role /** - * The role management APIs are generally the preferred way to manage roles, - * rather than using file-based role management. The create or update roles API - * cannot update roles that are defined in roles files. + * Create or update roles. + * <p> + * The role management APIs are generally the preferred way to manage roles in + * the native realm, rather than using file-based role management. The create or + * update roles API cannot update roles that are defined in roles files. + * File-based role management is not available in Elastic Serverless. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html">Documentation @@ -1656,9 +1844,12 @@ public CompletableFuture<PutRoleResponse> putRole(PutRoleRequest request) { } /** - * The role management APIs are generally the preferred way to manage roles, - * rather than using file-based role management. The create or update roles API - * cannot update roles that are defined in roles files. + * Create or update roles. + * <p> + * The role management APIs are generally the preferred way to manage roles in + * the native realm, rather than using file-based role management. The create or + * update roles API cannot update roles that are defined in roles files. + * File-based role management is not available in Elastic Serverless. * * @param fn * a function that initializes a builder to create the @@ -1676,7 +1867,17 @@ public final CompletableFuture<PutRoleResponse> putRole( // ----- Endpoint: security.put_role_mapping /** - * Creates and updates role mappings. + * Create or update role mappings. + * <p> + * Role mappings define which roles are assigned to each user. Each mapping has + * rules that identify users and a list of roles that are granted to those + * users. The role mapping APIs are generally the preferred way to manage role + * mappings rather than using role mapping files. The create or update role + * mappings API cannot update role mappings that are defined in role mapping + * files. + * <p> + * This API does not create roles. Rather, it maps users to existing roles. + * Roles can be created by using the create or update roles API or roles files. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role-mapping.html">Documentation @@ -1691,7 +1892,17 @@ public CompletableFuture<PutRoleMappingResponse> putRoleMapping(PutRoleMappingRe } /** - * Creates and updates role mappings. + * Create or update role mappings. + * <p> + * Role mappings define which roles are assigned to each user. Each mapping has + * rules that identify users and a list of roles that are granted to those + * users. The role mapping APIs are generally the preferred way to manage role + * mappings rather than using role mapping files. The create or update role + * mappings API cannot update role mappings that are defined in role mapping + * files. + * <p> + * This API does not create roles. Rather, it maps users to existing roles. + * Roles can be created by using the create or update roles API or roles files. * * @param fn * a function that initializes a builder to create the @@ -1709,8 +1920,11 @@ public final CompletableFuture<PutRoleMappingResponse> putRoleMapping( // ----- Endpoint: security.put_user /** - * Adds and updates users in the native realm. These users are commonly referred - * to as native users. + * Create or update users. + * <p> + * A password is required for adding a new user but is optional when updating an + * existing user. To change a user’s password without updating any other fields, + * use the change password API. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html">Documentation @@ -1725,8 +1939,11 @@ public CompletableFuture<PutUserResponse> putUser(PutUserRequest request) { } /** - * Adds and updates users in the native realm. These users are commonly referred - * to as native users. + * Create or update users. + * <p> + * A password is required for adding a new user but is optional when updating an + * existing user. To change a user’s password without updating any other fields, + * use the change password API. * * @param fn * a function that initializes a builder to create the @@ -1744,8 +1961,10 @@ public final CompletableFuture<PutUserResponse> putUser( // ----- Endpoint: security.query_api_keys /** - * Query API keys. Retrieves a paginated list of API keys and their information. - * You can optionally filter the results with a query. + * Find API keys with a query. + * <p> + * Get a paginated list of API keys and their information. You can optionally + * filter the results with a query. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-api-key.html">Documentation @@ -1760,8 +1979,10 @@ public CompletableFuture<QueryApiKeysResponse> queryApiKeys(QueryApiKeysRequest } /** - * Query API keys. Retrieves a paginated list of API keys and their information. - * You can optionally filter the results with a query. + * Find API keys with a query. + * <p> + * Get a paginated list of API keys and their information. You can optionally + * filter the results with a query. * * @param fn * a function that initializes a builder to create the @@ -1777,8 +1998,10 @@ public final CompletableFuture<QueryApiKeysResponse> queryApiKeys( } /** - * Query API keys. Retrieves a paginated list of API keys and their information. - * You can optionally filter the results with a query. + * Find API keys with a query. + * <p> + * Get a paginated list of API keys and their information. You can optionally + * filter the results with a query. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-api-key.html">Documentation @@ -1793,8 +2016,10 @@ public CompletableFuture<QueryApiKeysResponse> queryApiKeys() { // ----- Endpoint: security.query_role /** - * Retrieves roles in a paginated manner. You can optionally filter the results - * with a query. + * Find roles with a query. + * <p> + * Get roles in a paginated manner. You can optionally filter the results with a + * query. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-role.html">Documentation @@ -1809,8 +2034,10 @@ public CompletableFuture<QueryRoleResponse> queryRole(QueryRoleRequest request) } /** - * Retrieves roles in a paginated manner. You can optionally filter the results - * with a query. + * Find roles with a query. + * <p> + * Get roles in a paginated manner. You can optionally filter the results with a + * query. * * @param fn * a function that initializes a builder to create the @@ -1826,8 +2053,10 @@ public final CompletableFuture<QueryRoleResponse> queryRole( } /** - * Retrieves roles in a paginated manner. You can optionally filter the results - * with a query. + * Find roles with a query. + * <p> + * Get roles in a paginated manner. You can optionally filter the results with a + * query. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-role.html">Documentation @@ -1842,8 +2071,10 @@ public CompletableFuture<QueryRoleResponse> queryRole() { // ----- Endpoint: security.query_user /** - * Retrieves information for Users in a paginated manner. You can optionally - * filter the results with a query. + * Find users with a query. + * <p> + * Get information for users in a paginated manner. You can optionally filter + * the results with a query. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-user.html">Documentation @@ -1858,8 +2089,10 @@ public CompletableFuture<QueryUserResponse> queryUser(QueryUserRequest request) } /** - * Retrieves information for Users in a paginated manner. You can optionally - * filter the results with a query. + * Find users with a query. + * <p> + * Get information for users in a paginated manner. You can optionally filter + * the results with a query. * * @param fn * a function that initializes a builder to create the @@ -1875,8 +2108,10 @@ public final CompletableFuture<QueryUserResponse> queryUser( } /** - * Retrieves information for Users in a paginated manner. You can optionally - * filter the results with a query. + * Find users with a query. + * <p> + * Get information for users in a paginated manner. You can optionally filter + * the results with a query. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-user.html">Documentation @@ -1891,7 +2126,9 @@ public CompletableFuture<QueryUserResponse> queryUser() { // ----- Endpoint: security.saml_authenticate /** - * Submits a SAML Response message to Elasticsearch for consumption. + * Authenticate SAML. + * <p> + * Submits a SAML response message to Elasticsearch for consumption. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-authenticate.html">Documentation @@ -1906,7 +2143,9 @@ public CompletableFuture<SamlAuthenticateResponse> samlAuthenticate(SamlAuthenti } /** - * Submits a SAML Response message to Elasticsearch for consumption. + * Authenticate SAML. + * <p> + * Submits a SAML response message to Elasticsearch for consumption. * * @param fn * a function that initializes a builder to create the @@ -1924,6 +2163,8 @@ public final CompletableFuture<SamlAuthenticateResponse> samlAuthenticate( // ----- Endpoint: security.saml_complete_logout /** + * Logout of SAML completely. + * <p> * Verifies the logout response sent from the SAML IdP. * * @see <a href= @@ -1939,6 +2180,8 @@ public CompletableFuture<BooleanResponse> samlCompleteLogout(SamlCompleteLogoutR } /** + * Logout of SAML completely. + * <p> * Verifies the logout response sent from the SAML IdP. * * @param fn @@ -1957,6 +2200,8 @@ public final CompletableFuture<BooleanResponse> samlCompleteLogout( // ----- Endpoint: security.saml_invalidate /** + * Invalidate SAML. + * <p> * Submits a SAML LogoutRequest message to Elasticsearch for consumption. * * @see <a href= @@ -1972,6 +2217,8 @@ public CompletableFuture<SamlInvalidateResponse> samlInvalidate(SamlInvalidateRe } /** + * Invalidate SAML. + * <p> * Submits a SAML LogoutRequest message to Elasticsearch for consumption. * * @param fn @@ -1990,6 +2237,8 @@ public final CompletableFuture<SamlInvalidateResponse> samlInvalidate( // ----- Endpoint: security.saml_logout /** + * Logout of SAML. + * <p> * Submits a request to invalidate an access token and refresh token. * * @see <a href= @@ -2005,6 +2254,8 @@ public CompletableFuture<SamlLogoutResponse> samlLogout(SamlLogoutRequest reques } /** + * Logout of SAML. + * <p> * Submits a request to invalidate an access token and refresh token. * * @param fn @@ -2023,8 +2274,11 @@ public final CompletableFuture<SamlLogoutResponse> samlLogout( // ----- Endpoint: security.saml_prepare_authentication /** - * Creates a SAML authentication request (<AuthnRequest>) as a URL string, - * based on the configuration of the respective SAML realm in Elasticsearch. + * Prepare SAML authentication. + * <p> + * Creates a SAML authentication request (<code><AuthnRequest></code>) as + * a URL string, based on the configuration of the respective SAML realm in + * Elasticsearch. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-prepare-authentication.html">Documentation @@ -2040,8 +2294,11 @@ public CompletableFuture<SamlPrepareAuthenticationResponse> samlPrepareAuthentic } /** - * Creates a SAML authentication request (<AuthnRequest>) as a URL string, - * based on the configuration of the respective SAML realm in Elasticsearch. + * Prepare SAML authentication. + * <p> + * Creates a SAML authentication request (<code><AuthnRequest></code>) as + * a URL string, based on the configuration of the respective SAML realm in + * Elasticsearch. * * @param fn * a function that initializes a builder to create the @@ -2057,8 +2314,11 @@ public final CompletableFuture<SamlPrepareAuthenticationResponse> samlPrepareAut } /** - * Creates a SAML authentication request (<AuthnRequest>) as a URL string, - * based on the configuration of the respective SAML realm in Elasticsearch. + * Prepare SAML authentication. + * <p> + * Creates a SAML authentication request (<code><AuthnRequest></code>) as + * a URL string, based on the configuration of the respective SAML realm in + * Elasticsearch. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-prepare-authentication.html">Documentation @@ -2073,6 +2333,8 @@ public CompletableFuture<SamlPrepareAuthenticationResponse> samlPrepareAuthentic // ----- Endpoint: security.saml_service_provider_metadata /** + * Create SAML service provider metadata. + * <p> * Generate SAML metadata for a SAML 2.0 Service Provider. * * @see <a href= @@ -2089,6 +2351,8 @@ public CompletableFuture<SamlServiceProviderMetadataResponse> samlServiceProvide } /** + * Create SAML service provider metadata. + * <p> * Generate SAML metadata for a SAML 2.0 Service Provider. * * @param fn @@ -2107,6 +2371,8 @@ public final CompletableFuture<SamlServiceProviderMetadataResponse> samlServiceP // ----- Endpoint: security.suggest_user_profiles /** + * Suggest a user profile. + * <p> * Get suggestions for user profiles that match specified search criteria. * * @see <a href= @@ -2122,6 +2388,8 @@ public CompletableFuture<SuggestUserProfilesResponse> suggestUserProfiles(Sugges } /** + * Suggest a user profile. + * <p> * Get suggestions for user profiles that match specified search criteria. * * @param fn @@ -2138,6 +2406,8 @@ public final CompletableFuture<SuggestUserProfilesResponse> suggestUserProfiles( } /** + * Suggest a user profile. + * <p> * Get suggestions for user profiles that match specified search criteria. * * @see <a href= @@ -2153,22 +2423,24 @@ public CompletableFuture<SuggestUserProfilesResponse> suggestUserProfiles() { // ----- Endpoint: security.update_api_key /** - * Update an API key. Updates attributes of an existing API key. Users can only - * update API keys that they created or that were granted to them. Use this API - * to update API keys created by the create API Key or grant API Key APIs. If - * you need to apply the same update to many API keys, you can use bulk update - * API Keys to reduce overhead. It’s not possible to update expired API keys, or - * API keys that have been invalidated by invalidate API Key. This API supports - * updates to an API key’s access scope and metadata. The access scope of an API - * key is derived from the <code>role_descriptors</code> you specify in the - * request, and a snapshot of the owner user’s permissions at the time of the - * request. The snapshot of the owner’s permissions is updated automatically on - * every call. If you don’t specify <code>role_descriptors</code> in the - * request, a call to this API might still change the API key’s access scope. - * This change can occur if the owner user’s permissions have changed since the - * API key was created or last modified. To update another user’s API key, use - * the <code>run_as</code> feature to submit a request on behalf of another - * user. IMPORTANT: It’s not possible to use an API key as the authentication + * Update an API key. + * <p> + * Updates attributes of an existing API key. Users can only update API keys + * that they created or that were granted to them. Use this API to update API + * keys created by the create API Key or grant API Key APIs. If you need to + * apply the same update to many API keys, you can use bulk update API Keys to + * reduce overhead. It’s not possible to update expired API keys, or API keys + * that have been invalidated by invalidate API Key. This API supports updates + * to an API key’s access scope and metadata. The access scope of an API key is + * derived from the <code>role_descriptors</code> you specify in the request, + * and a snapshot of the owner user’s permissions at the time of the request. + * The snapshot of the owner’s permissions is updated automatically on every + * call. If you don’t specify <code>role_descriptors</code> in the request, a + * call to this API might still change the API key’s access scope. This change + * can occur if the owner user’s permissions have changed since the API key was + * created or last modified. To update another user’s API key, use the + * <code>run_as</code> feature to submit a request on behalf of another user. + * IMPORTANT: It’s not possible to use an API key as the authentication * credential for this API. To update an API key, the owner user’s credentials * are required. * @@ -2185,22 +2457,24 @@ public CompletableFuture<UpdateApiKeyResponse> updateApiKey(UpdateApiKeyRequest } /** - * Update an API key. Updates attributes of an existing API key. Users can only - * update API keys that they created or that were granted to them. Use this API - * to update API keys created by the create API Key or grant API Key APIs. If - * you need to apply the same update to many API keys, you can use bulk update - * API Keys to reduce overhead. It’s not possible to update expired API keys, or - * API keys that have been invalidated by invalidate API Key. This API supports - * updates to an API key’s access scope and metadata. The access scope of an API - * key is derived from the <code>role_descriptors</code> you specify in the - * request, and a snapshot of the owner user’s permissions at the time of the - * request. The snapshot of the owner’s permissions is updated automatically on - * every call. If you don’t specify <code>role_descriptors</code> in the - * request, a call to this API might still change the API key’s access scope. - * This change can occur if the owner user’s permissions have changed since the - * API key was created or last modified. To update another user’s API key, use - * the <code>run_as</code> feature to submit a request on behalf of another - * user. IMPORTANT: It’s not possible to use an API key as the authentication + * Update an API key. + * <p> + * Updates attributes of an existing API key. Users can only update API keys + * that they created or that were granted to them. Use this API to update API + * keys created by the create API Key or grant API Key APIs. If you need to + * apply the same update to many API keys, you can use bulk update API Keys to + * reduce overhead. It’s not possible to update expired API keys, or API keys + * that have been invalidated by invalidate API Key. This API supports updates + * to an API key’s access scope and metadata. The access scope of an API key is + * derived from the <code>role_descriptors</code> you specify in the request, + * and a snapshot of the owner user’s permissions at the time of the request. + * The snapshot of the owner’s permissions is updated automatically on every + * call. If you don’t specify <code>role_descriptors</code> in the request, a + * call to this API might still change the API key’s access scope. This change + * can occur if the owner user’s permissions have changed since the API key was + * created or last modified. To update another user’s API key, use the + * <code>run_as</code> feature to submit a request on behalf of another user. + * IMPORTANT: It’s not possible to use an API key as the authentication * credential for this API. To update an API key, the owner user’s credentials * are required. * @@ -2220,8 +2494,10 @@ public final CompletableFuture<UpdateApiKeyResponse> updateApiKey( // ----- Endpoint: security.update_user_profile_data /** - * Updates specific data for the user profile that's associated with the - * specified unique ID. + * Update user profile data. + * <p> + * Update specific data for the user profile that is associated with a unique + * ID. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-user-profile-data.html">Documentation @@ -2237,8 +2513,10 @@ public CompletableFuture<UpdateUserProfileDataResponse> updateUserProfileData( } /** - * Updates specific data for the user profile that's associated with the - * specified unique ID. + * Update user profile data. + * <p> + * Update specific data for the user profile that is associated with a unique + * ID. * * @param fn * a function that initializes a builder to create the diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/ElasticsearchSecurityClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/ElasticsearchSecurityClient.java index 4e49cc32e..e760354da 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/ElasticsearchSecurityClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/ElasticsearchSecurityClient.java @@ -69,7 +69,9 @@ public ElasticsearchSecurityClient withTransportOptions(@Nullable TransportOptio // ----- Endpoint: security.activate_user_profile /** - * Creates or updates a user profile on behalf of another user. + * Activate a user profile. + * <p> + * Create or update a user profile on behalf of another user. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-activate-user-profile.html">Documentation @@ -85,7 +87,9 @@ public ActivateUserProfileResponse activateUserProfile(ActivateUserProfileReques } /** - * Creates or updates a user profile on behalf of another user. + * Activate a user profile. + * <p> + * Create or update a user profile on behalf of another user. * * @param fn * a function that initializes a builder to create the @@ -104,8 +108,10 @@ public final ActivateUserProfileResponse activateUserProfile( // ----- Endpoint: security.authenticate /** - * Authenticate a user. Authenticates a user and returns information about the - * authenticated user. Include the user information in a + * Authenticate a user. + * <p> + * Authenticates a user and returns information about the authenticated user. + * Include the user information in a * <a href="https://en.wikipedia.org/wiki/Basic_access_authentication">basic * auth header</a>. A successful call returns a JSON structure that shows user * information such as their username, the roles that are assigned to the user, @@ -125,6 +131,8 @@ public AuthenticateResponse authenticate() throws IOException, ElasticsearchExce // ----- Endpoint: security.bulk_delete_role /** + * Bulk delete roles. + * <p> * The role management APIs are generally the preferred way to manage roles, * rather than using file-based role management. The bulk delete roles API * cannot delete roles that are defined in roles files. @@ -143,6 +151,8 @@ public BulkDeleteRoleResponse bulkDeleteRole(BulkDeleteRoleRequest request) } /** + * Bulk delete roles. + * <p> * The role management APIs are generally the preferred way to manage roles, * rather than using file-based role management. The bulk delete roles API * cannot delete roles that are defined in roles files. @@ -164,6 +174,8 @@ public final BulkDeleteRoleResponse bulkDeleteRole( // ----- Endpoint: security.bulk_put_role /** + * Bulk create or update roles. + * <p> * The role management APIs are generally the preferred way to manage roles, * rather than using file-based role management. The bulk create or update roles * API cannot update roles that are defined in roles files. @@ -181,6 +193,8 @@ public BulkPutRoleResponse bulkPutRole(BulkPutRoleRequest request) throws IOExce } /** + * Bulk create or update roles. + * <p> * The role management APIs are generally the preferred way to manage roles, * rather than using file-based role management. The bulk create or update roles * API cannot update roles that are defined in roles files. @@ -202,7 +216,9 @@ public final BulkPutRoleResponse bulkPutRole( // ----- Endpoint: security.change_password /** - * Changes the passwords of users in the native realm and built-in users. + * Change passwords. + * <p> + * Change the passwords of users in the native realm and built-in users. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-change-password.html">Documentation @@ -218,7 +234,9 @@ public ChangePasswordResponse changePassword(ChangePasswordRequest request) } /** - * Changes the passwords of users in the native realm and built-in users. + * Change passwords. + * <p> + * Change the passwords of users in the native realm and built-in users. * * @param fn * a function that initializes a builder to create the @@ -235,7 +253,9 @@ public final ChangePasswordResponse changePassword( } /** - * Changes the passwords of users in the native realm and built-in users. + * Change passwords. + * <p> + * Change the passwords of users in the native realm and built-in users. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-change-password.html">Documentation @@ -250,7 +270,9 @@ public ChangePasswordResponse changePassword() throws IOException, Elasticsearch // ----- Endpoint: security.clear_api_key_cache /** - * Evicts a subset of all entries from the API key cache. The cache is also + * Clear the API key cache. + * <p> + * Evict a subset of all entries from the API key cache. The cache is also * automatically cleared on state changes of the security index. * * @see <a href= @@ -267,7 +289,9 @@ public ClearApiKeyCacheResponse clearApiKeyCache(ClearApiKeyCacheRequest request } /** - * Evicts a subset of all entries from the API key cache. The cache is also + * Clear the API key cache. + * <p> + * Evict a subset of all entries from the API key cache. The cache is also * automatically cleared on state changes of the security index. * * @param fn @@ -287,7 +311,11 @@ public final ClearApiKeyCacheResponse clearApiKeyCache( // ----- Endpoint: security.clear_cached_privileges /** - * Evicts application privileges from the native application privileges cache. + * Clear the privileges cache. + * <p> + * Evict privileges from the native application privilege cache. The cache is + * also automatically cleared for applications that have their privileges + * updated. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-privilege-cache.html">Documentation @@ -303,7 +331,11 @@ public ClearCachedPrivilegesResponse clearCachedPrivileges(ClearCachedPrivileges } /** - * Evicts application privileges from the native application privileges cache. + * Clear the privileges cache. + * <p> + * Evict privileges from the native application privilege cache. The cache is + * also automatically cleared for applications that have their privileges + * updated. * * @param fn * a function that initializes a builder to create the @@ -322,7 +354,9 @@ public final ClearCachedPrivilegesResponse clearCachedPrivileges( // ----- Endpoint: security.clear_cached_realms /** - * Evicts users from the user cache. Can completely clear the cache or evict + * Clear the user cache. + * <p> + * Evict users from the user cache. You can completely clear the cache or evict * specific users. * * @see <a href= @@ -339,7 +373,9 @@ public ClearCachedRealmsResponse clearCachedRealms(ClearCachedRealmsRequest requ } /** - * Evicts users from the user cache. Can completely clear the cache or evict + * Clear the user cache. + * <p> + * Evict users from the user cache. You can completely clear the cache or evict * specific users. * * @param fn @@ -359,7 +395,9 @@ public final ClearCachedRealmsResponse clearCachedRealms( // ----- Endpoint: security.clear_cached_roles /** - * Evicts roles from the native role cache. + * Clear the roles cache. + * <p> + * Evict roles from the native role cache. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-role-cache.html">Documentation @@ -375,7 +413,9 @@ public ClearCachedRolesResponse clearCachedRoles(ClearCachedRolesRequest request } /** - * Evicts roles from the native role cache. + * Clear the roles cache. + * <p> + * Evict roles from the native role cache. * * @param fn * a function that initializes a builder to create the @@ -394,7 +434,9 @@ public final ClearCachedRolesResponse clearCachedRoles( // ----- Endpoint: security.clear_cached_service_tokens /** - * Evicts tokens from the service account token caches. + * Clear service account token caches. + * <p> + * Evict a subset of all entries from the service account token caches. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-service-token-caches.html">Documentation @@ -410,7 +452,9 @@ public ClearCachedServiceTokensResponse clearCachedServiceTokens(ClearCachedServ } /** - * Evicts tokens from the service account token caches. + * Clear service account token caches. + * <p> + * Evict a subset of all entries from the service account token caches. * * @param fn * a function that initializes a builder to create the @@ -429,12 +473,13 @@ public final ClearCachedServiceTokensResponse clearCachedServiceTokens( // ----- Endpoint: security.create_api_key /** - * Create an API key. Creates an API key for access without requiring basic - * authentication. A successful request returns a JSON structure that contains - * the API key, its unique id, and its name. If applicable, it also returns - * expiration information for the API key in milliseconds. NOTE: By default, API - * keys never expire. You can specify expiration information when you create the - * API keys. + * Create an API key. + * <p> + * Create an API key for access without requiring basic authentication. A + * successful request returns a JSON structure that contains the API key, its + * unique id, and its name. If applicable, it also returns expiration + * information for the API key in milliseconds. NOTE: By default, API keys never + * expire. You can specify expiration information when you create the API keys. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html">Documentation @@ -449,12 +494,13 @@ public CreateApiKeyResponse createApiKey(CreateApiKeyRequest request) throws IOE } /** - * Create an API key. Creates an API key for access without requiring basic - * authentication. A successful request returns a JSON structure that contains - * the API key, its unique id, and its name. If applicable, it also returns - * expiration information for the API key in milliseconds. NOTE: By default, API - * keys never expire. You can specify expiration information when you create the - * API keys. + * Create an API key. + * <p> + * Create an API key for access without requiring basic authentication. A + * successful request returns a JSON structure that contains the API key, its + * unique id, and its name. If applicable, it also returns expiration + * information for the API key in milliseconds. NOTE: By default, API keys never + * expire. You can specify expiration information when you create the API keys. * * @param fn * a function that initializes a builder to create the @@ -471,12 +517,13 @@ public final CreateApiKeyResponse createApiKey( } /** - * Create an API key. Creates an API key for access without requiring basic - * authentication. A successful request returns a JSON structure that contains - * the API key, its unique id, and its name. If applicable, it also returns - * expiration information for the API key in milliseconds. NOTE: By default, API - * keys never expire. You can specify expiration information when you create the - * API keys. + * Create an API key. + * <p> + * Create an API key for access without requiring basic authentication. A + * successful request returns a JSON structure that contains the API key, its + * unique id, and its name. If applicable, it also returns expiration + * information for the API key in milliseconds. NOTE: By default, API keys never + * expire. You can specify expiration information when you create the API keys. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html">Documentation @@ -491,7 +538,9 @@ public CreateApiKeyResponse createApiKey() throws IOException, ElasticsearchExce // ----- Endpoint: security.create_service_token /** - * Creates a service accounts token for access without requiring basic + * Create a service account token. + * <p> + * Create a service accounts token for access without requiring basic * authentication. * * @see <a href= @@ -508,7 +557,9 @@ public CreateServiceTokenResponse createServiceToken(CreateServiceTokenRequest r } /** - * Creates a service accounts token for access without requiring basic + * Create a service account token. + * <p> + * Create a service accounts token for access without requiring basic * authentication. * * @param fn @@ -528,7 +579,7 @@ public final CreateServiceTokenResponse createServiceToken( // ----- Endpoint: security.delete_privileges /** - * Removes application privileges. + * Delete application privileges. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-privilege.html">Documentation @@ -544,7 +595,7 @@ public DeletePrivilegesResponse deletePrivileges(DeletePrivilegesRequest request } /** - * Removes application privileges. + * Delete application privileges. * * @param fn * a function that initializes a builder to create the @@ -563,7 +614,9 @@ public final DeletePrivilegesResponse deletePrivileges( // ----- Endpoint: security.delete_role /** - * Removes roles in the native realm. + * Delete roles. + * <p> + * Delete roles in the native realm. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role.html">Documentation @@ -578,7 +631,9 @@ public DeleteRoleResponse deleteRole(DeleteRoleRequest request) throws IOExcepti } /** - * Removes roles in the native realm. + * Delete roles. + * <p> + * Delete roles in the native realm. * * @param fn * a function that initializes a builder to create the @@ -596,7 +651,7 @@ public final DeleteRoleResponse deleteRole(Function<DeleteRoleRequest.Builder, O // ----- Endpoint: security.delete_role_mapping /** - * Removes role mappings. + * Delete role mappings. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role-mapping.html">Documentation @@ -612,7 +667,7 @@ public DeleteRoleMappingResponse deleteRoleMapping(DeleteRoleMappingRequest requ } /** - * Removes role mappings. + * Delete role mappings. * * @param fn * a function that initializes a builder to create the @@ -631,7 +686,9 @@ public final DeleteRoleMappingResponse deleteRoleMapping( // ----- Endpoint: security.delete_service_token /** - * Deletes a service account token. + * Delete service account tokens. + * <p> + * Delete service account tokens for a service in a specified namespace. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-service-token.html">Documentation @@ -647,7 +704,9 @@ public DeleteServiceTokenResponse deleteServiceToken(DeleteServiceTokenRequest r } /** - * Deletes a service account token. + * Delete service account tokens. + * <p> + * Delete service account tokens for a service in a specified namespace. * * @param fn * a function that initializes a builder to create the @@ -666,7 +725,9 @@ public final DeleteServiceTokenResponse deleteServiceToken( // ----- Endpoint: security.delete_user /** - * Deletes users from the native realm. + * Delete users. + * <p> + * Delete users from the native realm. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-user.html">Documentation @@ -681,7 +742,9 @@ public DeleteUserResponse deleteUser(DeleteUserRequest request) throws IOExcepti } /** - * Deletes users from the native realm. + * Delete users. + * <p> + * Delete users from the native realm. * * @param fn * a function that initializes a builder to create the @@ -699,7 +762,9 @@ public final DeleteUserResponse deleteUser(Function<DeleteUserRequest.Builder, O // ----- Endpoint: security.disable_user /** - * Disables users in the native realm. + * Disable users. + * <p> + * Disable users in the native realm. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-disable-user.html">Documentation @@ -714,7 +779,9 @@ public DisableUserResponse disableUser(DisableUserRequest request) throws IOExce } /** - * Disables users in the native realm. + * Disable users. + * <p> + * Disable users in the native realm. * * @param fn * a function that initializes a builder to create the @@ -733,7 +800,9 @@ public final DisableUserResponse disableUser( // ----- Endpoint: security.disable_user_profile /** - * Disables a user profile so it's not visible in user profile searches. + * Disable a user profile. + * <p> + * Disable user profiles so that they are not visible in user profile searches. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-disable-user-profile.html">Documentation @@ -749,7 +818,9 @@ public DisableUserProfileResponse disableUserProfile(DisableUserProfileRequest r } /** - * Disables a user profile so it's not visible in user profile searches. + * Disable a user profile. + * <p> + * Disable user profiles so that they are not visible in user profile searches. * * @param fn * a function that initializes a builder to create the @@ -768,7 +839,9 @@ public final DisableUserProfileResponse disableUserProfile( // ----- Endpoint: security.enable_user /** - * Enables users in the native realm. + * Enable users. + * <p> + * Enable users in the native realm. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-enable-user.html">Documentation @@ -783,7 +856,9 @@ public EnableUserResponse enableUser(EnableUserRequest request) throws IOExcepti } /** - * Enables users in the native realm. + * Enable users. + * <p> + * Enable users in the native realm. * * @param fn * a function that initializes a builder to create the @@ -801,7 +876,9 @@ public final EnableUserResponse enableUser(Function<EnableUserRequest.Builder, O // ----- Endpoint: security.enable_user_profile /** - * Enables a user profile so it's visible in user profile searches. + * Enable a user profile. + * <p> + * Enable user profiles to make them visible in user profile searches. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-enable-user-profile.html">Documentation @@ -817,7 +894,9 @@ public EnableUserProfileResponse enableUserProfile(EnableUserProfileRequest requ } /** - * Enables a user profile so it's visible in user profile searches. + * Enable a user profile. + * <p> + * Enable user profiles to make them visible in user profile searches. * * @param fn * a function that initializes a builder to create the @@ -836,8 +915,10 @@ public final EnableUserProfileResponse enableUserProfile( // ----- Endpoint: security.enroll_kibana /** - * Enables a Kibana instance to configure itself for communication with a - * secured Elasticsearch cluster. + * Enroll Kibana. + * <p> + * Enable a Kibana instance to configure itself for communication with a secured + * Elasticsearch cluster. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-kibana-enrollment.html">Documentation @@ -851,7 +932,10 @@ public EnrollKibanaResponse enrollKibana() throws IOException, ElasticsearchExce // ----- Endpoint: security.enroll_node /** - * Allows a new node to join an existing cluster with security features enabled. + * Enroll a node. + * <p> + * Enroll a new node to allow it to join an existing cluster with security + * features enabled. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-node-enrollment.html">Documentation @@ -865,12 +949,14 @@ public EnrollNodeResponse enrollNode() throws IOException, ElasticsearchExceptio // ----- Endpoint: security.get_api_key /** - * Get API key information. Retrieves information for one or more API keys. - * NOTE: If you have only the <code>manage_own_api_key</code> privilege, this - * API returns only the API keys that you own. If you have - * <code>read_security</code>, <code>manage_api_key</code> or greater privileges - * (including <code>manage_security</code>), this API returns all API keys - * regardless of ownership. + * Get API key information. + * <p> + * Retrieves information for one or more API keys. NOTE: If you have only the + * <code>manage_own_api_key</code> privilege, this API returns only the API keys + * that you own. If you have <code>read_security</code>, + * <code>manage_api_key</code> or greater privileges (including + * <code>manage_security</code>), this API returns all API keys regardless of + * ownership. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html">Documentation @@ -885,12 +971,14 @@ public GetApiKeyResponse getApiKey(GetApiKeyRequest request) throws IOException, } /** - * Get API key information. Retrieves information for one or more API keys. - * NOTE: If you have only the <code>manage_own_api_key</code> privilege, this - * API returns only the API keys that you own. If you have - * <code>read_security</code>, <code>manage_api_key</code> or greater privileges - * (including <code>manage_security</code>), this API returns all API keys - * regardless of ownership. + * Get API key information. + * <p> + * Retrieves information for one or more API keys. NOTE: If you have only the + * <code>manage_own_api_key</code> privilege, this API returns only the API keys + * that you own. If you have <code>read_security</code>, + * <code>manage_api_key</code> or greater privileges (including + * <code>manage_security</code>), this API returns all API keys regardless of + * ownership. * * @param fn * a function that initializes a builder to create the @@ -906,12 +994,14 @@ public final GetApiKeyResponse getApiKey(Function<GetApiKeyRequest.Builder, Obje } /** - * Get API key information. Retrieves information for one or more API keys. - * NOTE: If you have only the <code>manage_own_api_key</code> privilege, this - * API returns only the API keys that you own. If you have - * <code>read_security</code>, <code>manage_api_key</code> or greater privileges - * (including <code>manage_security</code>), this API returns all API keys - * regardless of ownership. + * Get API key information. + * <p> + * Retrieves information for one or more API keys. NOTE: If you have only the + * <code>manage_own_api_key</code> privilege, this API returns only the API keys + * that you own. If you have <code>read_security</code>, + * <code>manage_api_key</code> or greater privileges (including + * <code>manage_security</code>), this API returns all API keys regardless of + * ownership. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html">Documentation @@ -926,8 +1016,10 @@ public GetApiKeyResponse getApiKey() throws IOException, ElasticsearchException // ----- Endpoint: security.get_builtin_privileges /** - * Retrieves the list of cluster privileges and index privileges that are - * available in this version of Elasticsearch. + * Get builtin privileges. + * <p> + * Get the list of cluster privileges and index privileges that are available in + * this version of Elasticsearch. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-builtin-privileges.html">Documentation @@ -941,7 +1033,7 @@ public GetBuiltinPrivilegesResponse getBuiltinPrivileges() throws IOException, E // ----- Endpoint: security.get_privileges /** - * Retrieves application privileges. + * Get application privileges. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-privileges.html">Documentation @@ -957,7 +1049,7 @@ public GetPrivilegesResponse getPrivileges(GetPrivilegesRequest request) } /** - * Retrieves application privileges. + * Get application privileges. * * @param fn * a function that initializes a builder to create the @@ -974,7 +1066,7 @@ public final GetPrivilegesResponse getPrivileges( } /** - * Retrieves application privileges. + * Get application privileges. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-privileges.html">Documentation @@ -989,9 +1081,11 @@ public GetPrivilegesResponse getPrivileges() throws IOException, ElasticsearchEx // ----- Endpoint: security.get_role /** - * The role management APIs are generally the preferred way to manage roles, - * rather than using file-based role management. The get roles API cannot - * retrieve roles that are defined in roles files. + * Get roles. + * <p> + * Get roles in the native realm. The role management APIs are generally the + * preferred way to manage roles, rather than using file-based role management. + * The get roles API cannot retrieve roles that are defined in roles files. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html">Documentation @@ -1006,9 +1100,11 @@ public GetRoleResponse getRole(GetRoleRequest request) throws IOException, Elast } /** - * The role management APIs are generally the preferred way to manage roles, - * rather than using file-based role management. The get roles API cannot - * retrieve roles that are defined in roles files. + * Get roles. + * <p> + * Get roles in the native realm. The role management APIs are generally the + * preferred way to manage roles, rather than using file-based role management. + * The get roles API cannot retrieve roles that are defined in roles files. * * @param fn * a function that initializes a builder to create the @@ -1024,9 +1120,11 @@ public final GetRoleResponse getRole(Function<GetRoleRequest.Builder, ObjectBuil } /** - * The role management APIs are generally the preferred way to manage roles, - * rather than using file-based role management. The get roles API cannot - * retrieve roles that are defined in roles files. + * Get roles. + * <p> + * Get roles in the native realm. The role management APIs are generally the + * preferred way to manage roles, rather than using file-based role management. + * The get roles API cannot retrieve roles that are defined in roles files. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html">Documentation @@ -1041,7 +1139,12 @@ public GetRoleResponse getRole() throws IOException, ElasticsearchException { // ----- Endpoint: security.get_role_mapping /** - * Retrieves role mappings. + * Get role mappings. + * <p> + * Role mappings define which roles are assigned to each user. The role mapping + * APIs are generally the preferred way to manage role mappings rather than + * using role mapping files. The get role mappings API cannot retrieve role + * mappings that are defined in role mapping files. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role-mapping.html">Documentation @@ -1057,7 +1160,12 @@ public GetRoleMappingResponse getRoleMapping(GetRoleMappingRequest request) } /** - * Retrieves role mappings. + * Get role mappings. + * <p> + * Role mappings define which roles are assigned to each user. The role mapping + * APIs are generally the preferred way to manage role mappings rather than + * using role mapping files. The get role mappings API cannot retrieve role + * mappings that are defined in role mapping files. * * @param fn * a function that initializes a builder to create the @@ -1074,7 +1182,12 @@ public final GetRoleMappingResponse getRoleMapping( } /** - * Retrieves role mappings. + * Get role mappings. + * <p> + * Role mappings define which roles are assigned to each user. The role mapping + * APIs are generally the preferred way to manage role mappings rather than + * using role mapping files. The get role mappings API cannot retrieve role + * mappings that are defined in role mapping files. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role-mapping.html">Documentation @@ -1089,8 +1202,9 @@ public GetRoleMappingResponse getRoleMapping() throws IOException, Elasticsearch // ----- Endpoint: security.get_service_accounts /** - * This API returns a list of service accounts that match the provided path - * parameter(s). + * Get service accounts. + * <p> + * Get a list of service accounts that match the provided path parameters. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-accounts.html">Documentation @@ -1106,8 +1220,9 @@ public GetServiceAccountsResponse getServiceAccounts(GetServiceAccountsRequest r } /** - * This API returns a list of service accounts that match the provided path - * parameter(s). + * Get service accounts. + * <p> + * Get a list of service accounts that match the provided path parameters. * * @param fn * a function that initializes a builder to create the @@ -1124,8 +1239,9 @@ public final GetServiceAccountsResponse getServiceAccounts( } /** - * This API returns a list of service accounts that match the provided path - * parameter(s). + * Get service accounts. + * <p> + * Get a list of service accounts that match the provided path parameters. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-accounts.html">Documentation @@ -1140,7 +1256,7 @@ public GetServiceAccountsResponse getServiceAccounts() throws IOException, Elast // ----- Endpoint: security.get_service_credentials /** - * Retrieves information of all service credentials for a service account. + * Get service account credentials. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-credentials.html">Documentation @@ -1156,7 +1272,7 @@ public GetServiceCredentialsResponse getServiceCredentials(GetServiceCredentials } /** - * Retrieves information of all service credentials for a service account. + * Get service account credentials. * * @param fn * a function that initializes a builder to create the @@ -1175,7 +1291,9 @@ public final GetServiceCredentialsResponse getServiceCredentials( // ----- Endpoint: security.get_token /** - * Creates a bearer token for access without requiring basic authentication. + * Get a token. + * <p> + * Create a bearer token for access without requiring basic authentication. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-token.html">Documentation @@ -1190,7 +1308,9 @@ public GetTokenResponse getToken(GetTokenRequest request) throws IOException, El } /** - * Creates a bearer token for access without requiring basic authentication. + * Get a token. + * <p> + * Create a bearer token for access without requiring basic authentication. * * @param fn * a function that initializes a builder to create the @@ -1206,7 +1326,9 @@ public final GetTokenResponse getToken(Function<GetTokenRequest.Builder, ObjectB } /** - * Creates a bearer token for access without requiring basic authentication. + * Get a token. + * <p> + * Create a bearer token for access without requiring basic authentication. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-token.html">Documentation @@ -1221,7 +1343,9 @@ public GetTokenResponse getToken() throws IOException, ElasticsearchException { // ----- Endpoint: security.get_user /** - * Retrieves information about users in the native realm and built-in users. + * Get users. + * <p> + * Get information about users in the native realm and built-in users. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user.html">Documentation @@ -1236,7 +1360,9 @@ public GetUserResponse getUser(GetUserRequest request) throws IOException, Elast } /** - * Retrieves information about users in the native realm and built-in users. + * Get users. + * <p> + * Get information about users in the native realm and built-in users. * * @param fn * a function that initializes a builder to create the @@ -1252,7 +1378,9 @@ public final GetUserResponse getUser(Function<GetUserRequest.Builder, ObjectBuil } /** - * Retrieves information about users in the native realm and built-in users. + * Get users. + * <p> + * Get information about users in the native realm and built-in users. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user.html">Documentation @@ -1267,7 +1395,7 @@ public GetUserResponse getUser() throws IOException, ElasticsearchException { // ----- Endpoint: security.get_user_privileges /** - * Retrieves security privileges for the logged in user. + * Get user privileges. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user-privileges.html">Documentation @@ -1283,7 +1411,7 @@ public GetUserPrivilegesResponse getUserPrivileges(GetUserPrivilegesRequest requ } /** - * Retrieves security privileges for the logged in user. + * Get user privileges. * * @param fn * a function that initializes a builder to create the @@ -1300,7 +1428,7 @@ public final GetUserPrivilegesResponse getUserPrivileges( } /** - * Retrieves security privileges for the logged in user. + * Get user privileges. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user-privileges.html">Documentation @@ -1315,7 +1443,9 @@ public GetUserPrivilegesResponse getUserPrivileges() throws IOException, Elastic // ----- Endpoint: security.get_user_profile /** - * Retrieves a user's profile using the unique profile ID. + * Get a user profile. + * <p> + * Get a user's profile using the unique profile ID. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user-profile.html">Documentation @@ -1331,7 +1461,9 @@ public GetUserProfileResponse getUserProfile(GetUserProfileRequest request) } /** - * Retrieves a user's profile using the unique profile ID. + * Get a user profile. + * <p> + * Get a user's profile using the unique profile ID. * * @param fn * a function that initializes a builder to create the @@ -1350,15 +1482,17 @@ public final GetUserProfileResponse getUserProfile( // ----- Endpoint: security.grant_api_key /** - * Creates an API key on behalf of another user. This API is similar to Create - * API keys, however it creates the API key for a user that is different than - * the user that runs the API. The caller must have authentication credentials - * (either an access token, or a username and password) for the user on whose - * behalf the API key will be created. It is not possible to use this API to - * create an API key without that user’s credentials. The user, for whom the - * authentication credentials is provided, can optionally "run as" - * (impersonate) another user. In this case, the API key will be created on - * behalf of the impersonated user. + * Grant an API key. + * <p> + * Create an API key on behalf of another user. This API is similar to the + * create API keys API, however it creates the API key for a user that is + * different than the user that runs the API. The caller must have + * authentication credentials (either an access token, or a username and + * password) for the user on whose behalf the API key will be created. It is not + * possible to use this API to create an API key without that user’s + * credentials. The user, for whom the authentication credentials is provided, + * can optionally "run as" (impersonate) another user. In this case, + * the API key will be created on behalf of the impersonated user. * <p> * This API is intended be used by applications that need to create and manage * API keys for end users, but cannot guarantee that those users have permission @@ -1384,15 +1518,17 @@ public GrantApiKeyResponse grantApiKey(GrantApiKeyRequest request) throws IOExce } /** - * Creates an API key on behalf of another user. This API is similar to Create - * API keys, however it creates the API key for a user that is different than - * the user that runs the API. The caller must have authentication credentials - * (either an access token, or a username and password) for the user on whose - * behalf the API key will be created. It is not possible to use this API to - * create an API key without that user’s credentials. The user, for whom the - * authentication credentials is provided, can optionally "run as" - * (impersonate) another user. In this case, the API key will be created on - * behalf of the impersonated user. + * Grant an API key. + * <p> + * Create an API key on behalf of another user. This API is similar to the + * create API keys API, however it creates the API key for a user that is + * different than the user that runs the API. The caller must have + * authentication credentials (either an access token, or a username and + * password) for the user on whose behalf the API key will be created. It is not + * possible to use this API to create an API key without that user’s + * credentials. The user, for whom the authentication credentials is provided, + * can optionally "run as" (impersonate) another user. In this case, + * the API key will be created on behalf of the impersonated user. * <p> * This API is intended be used by applications that need to create and manage * API keys for end users, but cannot guarantee that those users have permission @@ -1422,8 +1558,9 @@ public final GrantApiKeyResponse grantApiKey( // ----- Endpoint: security.has_privileges /** - * Check user privileges. Determines whether the specified user has a specified - * list of privileges. + * Check user privileges. + * <p> + * Determine whether the specified user has a specified list of privileges. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html">Documentation @@ -1439,8 +1576,9 @@ public HasPrivilegesResponse hasPrivileges(HasPrivilegesRequest request) } /** - * Check user privileges. Determines whether the specified user has a specified - * list of privileges. + * Check user privileges. + * <p> + * Determine whether the specified user has a specified list of privileges. * * @param fn * a function that initializes a builder to create the @@ -1457,8 +1595,9 @@ public final HasPrivilegesResponse hasPrivileges( } /** - * Check user privileges. Determines whether the specified user has a specified - * list of privileges. + * Check user privileges. + * <p> + * Determine whether the specified user has a specified list of privileges. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html">Documentation @@ -1473,8 +1612,10 @@ public HasPrivilegesResponse hasPrivileges() throws IOException, ElasticsearchEx // ----- Endpoint: security.has_privileges_user_profile /** - * Determines whether the users associated with the specified profile IDs have - * all the requested privileges. + * Check user profile privileges. + * <p> + * Determine whether the users associated with the specified user profile IDs + * have all the requested privileges. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges-user-profile.html">Documentation @@ -1490,8 +1631,10 @@ public HasPrivilegesUserProfileResponse hasPrivilegesUserProfile(HasPrivilegesUs } /** - * Determines whether the users associated with the specified profile IDs have - * all the requested privileges. + * Check user profile privileges. + * <p> + * Determine whether the users associated with the specified user profile IDs + * have all the requested privileges. * * @param fn * a function that initializes a builder to create the @@ -1510,8 +1653,13 @@ public final HasPrivilegesUserProfileResponse hasPrivilegesUserProfile( // ----- Endpoint: security.invalidate_api_key /** - * Invalidate API keys. Invalidates one or more API keys. The - * <code>manage_api_key</code> privilege allows deleting any API keys. The + * Invalidate API keys. + * <p> + * This API invalidates API keys created by the create API key or grant API key + * APIs. Invalidated API keys fail authentication, but they can still be viewed + * using the get API key information and query API key information APIs, for at + * least the configured retention period, until they are automatically deleted. + * The <code>manage_api_key</code> privilege allows deleting any API keys. The * <code>manage_own_api_key</code> only allows deleting API keys that are owned * by the user. In addition, with the <code>manage_own_api_key</code> privilege, * an invalidation request must be issued in one of the three formats: @@ -1519,8 +1667,8 @@ public final HasPrivilegesUserProfileResponse hasPrivilegesUserProfile( * <li>Set the parameter <code>owner=true</code>.</li> * <li>Or, set both <code>username</code> and <code>realm_name</code> to match * the user’s identity.</li> - * <li>Or, if the request is issued by an API key, i.e. an API key invalidates - * itself, specify its ID in the <code>ids</code> field.</li> + * <li>Or, if the request is issued by an API key, that is to say an API key + * invalidates itself, specify its ID in the <code>ids</code> field.</li> * </ul> * * @see <a href= @@ -1537,8 +1685,13 @@ public InvalidateApiKeyResponse invalidateApiKey(InvalidateApiKeyRequest request } /** - * Invalidate API keys. Invalidates one or more API keys. The - * <code>manage_api_key</code> privilege allows deleting any API keys. The + * Invalidate API keys. + * <p> + * This API invalidates API keys created by the create API key or grant API key + * APIs. Invalidated API keys fail authentication, but they can still be viewed + * using the get API key information and query API key information APIs, for at + * least the configured retention period, until they are automatically deleted. + * The <code>manage_api_key</code> privilege allows deleting any API keys. The * <code>manage_own_api_key</code> only allows deleting API keys that are owned * by the user. In addition, with the <code>manage_own_api_key</code> privilege, * an invalidation request must be issued in one of the three formats: @@ -1546,8 +1699,8 @@ public InvalidateApiKeyResponse invalidateApiKey(InvalidateApiKeyRequest request * <li>Set the parameter <code>owner=true</code>.</li> * <li>Or, set both <code>username</code> and <code>realm_name</code> to match * the user’s identity.</li> - * <li>Or, if the request is issued by an API key, i.e. an API key invalidates - * itself, specify its ID in the <code>ids</code> field.</li> + * <li>Or, if the request is issued by an API key, that is to say an API key + * invalidates itself, specify its ID in the <code>ids</code> field.</li> * </ul> * * @param fn @@ -1565,8 +1718,13 @@ public final InvalidateApiKeyResponse invalidateApiKey( } /** - * Invalidate API keys. Invalidates one or more API keys. The - * <code>manage_api_key</code> privilege allows deleting any API keys. The + * Invalidate API keys. + * <p> + * This API invalidates API keys created by the create API key or grant API key + * APIs. Invalidated API keys fail authentication, but they can still be viewed + * using the get API key information and query API key information APIs, for at + * least the configured retention period, until they are automatically deleted. + * The <code>manage_api_key</code> privilege allows deleting any API keys. The * <code>manage_own_api_key</code> only allows deleting API keys that are owned * by the user. In addition, with the <code>manage_own_api_key</code> privilege, * an invalidation request must be issued in one of the three formats: @@ -1574,8 +1732,8 @@ public final InvalidateApiKeyResponse invalidateApiKey( * <li>Set the parameter <code>owner=true</code>.</li> * <li>Or, set both <code>username</code> and <code>realm_name</code> to match * the user’s identity.</li> - * <li>Or, if the request is issued by an API key, i.e. an API key invalidates - * itself, specify its ID in the <code>ids</code> field.</li> + * <li>Or, if the request is issued by an API key, that is to say an API key + * invalidates itself, specify its ID in the <code>ids</code> field.</li> * </ul> * * @see <a href= @@ -1591,7 +1749,16 @@ public InvalidateApiKeyResponse invalidateApiKey() throws IOException, Elasticse // ----- Endpoint: security.invalidate_token /** - * Invalidates one or more access tokens or refresh tokens. + * Invalidate a token. + * <p> + * The access tokens returned by the get token API have a finite period of time + * for which they are valid. After that time period, they can no longer be used. + * The time period is defined by the + * <code>xpack.security.authc.token.timeout</code> setting. + * <p> + * The refresh tokens returned by the get token API are only valid for 24 hours. + * They can also be used exactly once. If you want to invalidate one or more + * access or refresh tokens immediately, use this invalidate token API. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-token.html">Documentation @@ -1607,7 +1774,16 @@ public InvalidateTokenResponse invalidateToken(InvalidateTokenRequest request) } /** - * Invalidates one or more access tokens or refresh tokens. + * Invalidate a token. + * <p> + * The access tokens returned by the get token API have a finite period of time + * for which they are valid. After that time period, they can no longer be used. + * The time period is defined by the + * <code>xpack.security.authc.token.timeout</code> setting. + * <p> + * The refresh tokens returned by the get token API are only valid for 24 hours. + * They can also be used exactly once. If you want to invalidate one or more + * access or refresh tokens immediately, use this invalidate token API. * * @param fn * a function that initializes a builder to create the @@ -1624,7 +1800,16 @@ public final InvalidateTokenResponse invalidateToken( } /** - * Invalidates one or more access tokens or refresh tokens. + * Invalidate a token. + * <p> + * The access tokens returned by the get token API have a finite period of time + * for which they are valid. After that time period, they can no longer be used. + * The time period is defined by the + * <code>xpack.security.authc.token.timeout</code> setting. + * <p> + * The refresh tokens returned by the get token API are only valid for 24 hours. + * They can also be used exactly once. If you want to invalidate one or more + * access or refresh tokens immediately, use this invalidate token API. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-token.html">Documentation @@ -1639,7 +1824,7 @@ public InvalidateTokenResponse invalidateToken() throws IOException, Elasticsear // ----- Endpoint: security.put_privileges /** - * Adds or updates application privileges. + * Create or update application privileges. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-privileges.html">Documentation @@ -1655,7 +1840,7 @@ public PutPrivilegesResponse putPrivileges(PutPrivilegesRequest request) } /** - * Adds or updates application privileges. + * Create or update application privileges. * * @param fn * a function that initializes a builder to create the @@ -1672,7 +1857,7 @@ public final PutPrivilegesResponse putPrivileges( } /** - * Adds or updates application privileges. + * Create or update application privileges. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-privileges.html">Documentation @@ -1687,9 +1872,12 @@ public PutPrivilegesResponse putPrivileges() throws IOException, ElasticsearchEx // ----- Endpoint: security.put_role /** - * The role management APIs are generally the preferred way to manage roles, - * rather than using file-based role management. The create or update roles API - * cannot update roles that are defined in roles files. + * Create or update roles. + * <p> + * The role management APIs are generally the preferred way to manage roles in + * the native realm, rather than using file-based role management. The create or + * update roles API cannot update roles that are defined in roles files. + * File-based role management is not available in Elastic Serverless. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html">Documentation @@ -1704,9 +1892,12 @@ public PutRoleResponse putRole(PutRoleRequest request) throws IOException, Elast } /** - * The role management APIs are generally the preferred way to manage roles, - * rather than using file-based role management. The create or update roles API - * cannot update roles that are defined in roles files. + * Create or update roles. + * <p> + * The role management APIs are generally the preferred way to manage roles in + * the native realm, rather than using file-based role management. The create or + * update roles API cannot update roles that are defined in roles files. + * File-based role management is not available in Elastic Serverless. * * @param fn * a function that initializes a builder to create the @@ -1724,7 +1915,17 @@ public final PutRoleResponse putRole(Function<PutRoleRequest.Builder, ObjectBuil // ----- Endpoint: security.put_role_mapping /** - * Creates and updates role mappings. + * Create or update role mappings. + * <p> + * Role mappings define which roles are assigned to each user. Each mapping has + * rules that identify users and a list of roles that are granted to those + * users. The role mapping APIs are generally the preferred way to manage role + * mappings rather than using role mapping files. The create or update role + * mappings API cannot update role mappings that are defined in role mapping + * files. + * <p> + * This API does not create roles. Rather, it maps users to existing roles. + * Roles can be created by using the create or update roles API or roles files. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role-mapping.html">Documentation @@ -1740,7 +1941,17 @@ public PutRoleMappingResponse putRoleMapping(PutRoleMappingRequest request) } /** - * Creates and updates role mappings. + * Create or update role mappings. + * <p> + * Role mappings define which roles are assigned to each user. Each mapping has + * rules that identify users and a list of roles that are granted to those + * users. The role mapping APIs are generally the preferred way to manage role + * mappings rather than using role mapping files. The create or update role + * mappings API cannot update role mappings that are defined in role mapping + * files. + * <p> + * This API does not create roles. Rather, it maps users to existing roles. + * Roles can be created by using the create or update roles API or roles files. * * @param fn * a function that initializes a builder to create the @@ -1759,8 +1970,11 @@ public final PutRoleMappingResponse putRoleMapping( // ----- Endpoint: security.put_user /** - * Adds and updates users in the native realm. These users are commonly referred - * to as native users. + * Create or update users. + * <p> + * A password is required for adding a new user but is optional when updating an + * existing user. To change a user’s password without updating any other fields, + * use the change password API. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html">Documentation @@ -1775,8 +1989,11 @@ public PutUserResponse putUser(PutUserRequest request) throws IOException, Elast } /** - * Adds and updates users in the native realm. These users are commonly referred - * to as native users. + * Create or update users. + * <p> + * A password is required for adding a new user but is optional when updating an + * existing user. To change a user’s password without updating any other fields, + * use the change password API. * * @param fn * a function that initializes a builder to create the @@ -1794,8 +2011,10 @@ public final PutUserResponse putUser(Function<PutUserRequest.Builder, ObjectBuil // ----- Endpoint: security.query_api_keys /** - * Query API keys. Retrieves a paginated list of API keys and their information. - * You can optionally filter the results with a query. + * Find API keys with a query. + * <p> + * Get a paginated list of API keys and their information. You can optionally + * filter the results with a query. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-api-key.html">Documentation @@ -1810,8 +2029,10 @@ public QueryApiKeysResponse queryApiKeys(QueryApiKeysRequest request) throws IOE } /** - * Query API keys. Retrieves a paginated list of API keys and their information. - * You can optionally filter the results with a query. + * Find API keys with a query. + * <p> + * Get a paginated list of API keys and their information. You can optionally + * filter the results with a query. * * @param fn * a function that initializes a builder to create the @@ -1828,8 +2049,10 @@ public final QueryApiKeysResponse queryApiKeys( } /** - * Query API keys. Retrieves a paginated list of API keys and their information. - * You can optionally filter the results with a query. + * Find API keys with a query. + * <p> + * Get a paginated list of API keys and their information. You can optionally + * filter the results with a query. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-api-key.html">Documentation @@ -1844,8 +2067,10 @@ public QueryApiKeysResponse queryApiKeys() throws IOException, ElasticsearchExce // ----- Endpoint: security.query_role /** - * Retrieves roles in a paginated manner. You can optionally filter the results - * with a query. + * Find roles with a query. + * <p> + * Get roles in a paginated manner. You can optionally filter the results with a + * query. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-role.html">Documentation @@ -1860,8 +2085,10 @@ public QueryRoleResponse queryRole(QueryRoleRequest request) throws IOException, } /** - * Retrieves roles in a paginated manner. You can optionally filter the results - * with a query. + * Find roles with a query. + * <p> + * Get roles in a paginated manner. You can optionally filter the results with a + * query. * * @param fn * a function that initializes a builder to create the @@ -1877,8 +2104,10 @@ public final QueryRoleResponse queryRole(Function<QueryRoleRequest.Builder, Obje } /** - * Retrieves roles in a paginated manner. You can optionally filter the results - * with a query. + * Find roles with a query. + * <p> + * Get roles in a paginated manner. You can optionally filter the results with a + * query. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-role.html">Documentation @@ -1893,8 +2122,10 @@ public QueryRoleResponse queryRole() throws IOException, ElasticsearchException // ----- Endpoint: security.query_user /** - * Retrieves information for Users in a paginated manner. You can optionally - * filter the results with a query. + * Find users with a query. + * <p> + * Get information for users in a paginated manner. You can optionally filter + * the results with a query. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-user.html">Documentation @@ -1909,8 +2140,10 @@ public QueryUserResponse queryUser(QueryUserRequest request) throws IOException, } /** - * Retrieves information for Users in a paginated manner. You can optionally - * filter the results with a query. + * Find users with a query. + * <p> + * Get information for users in a paginated manner. You can optionally filter + * the results with a query. * * @param fn * a function that initializes a builder to create the @@ -1926,8 +2159,10 @@ public final QueryUserResponse queryUser(Function<QueryUserRequest.Builder, Obje } /** - * Retrieves information for Users in a paginated manner. You can optionally - * filter the results with a query. + * Find users with a query. + * <p> + * Get information for users in a paginated manner. You can optionally filter + * the results with a query. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-user.html">Documentation @@ -1942,7 +2177,9 @@ public QueryUserResponse queryUser() throws IOException, ElasticsearchException // ----- Endpoint: security.saml_authenticate /** - * Submits a SAML Response message to Elasticsearch for consumption. + * Authenticate SAML. + * <p> + * Submits a SAML response message to Elasticsearch for consumption. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-authenticate.html">Documentation @@ -1958,7 +2195,9 @@ public SamlAuthenticateResponse samlAuthenticate(SamlAuthenticateRequest request } /** - * Submits a SAML Response message to Elasticsearch for consumption. + * Authenticate SAML. + * <p> + * Submits a SAML response message to Elasticsearch for consumption. * * @param fn * a function that initializes a builder to create the @@ -1977,6 +2216,8 @@ public final SamlAuthenticateResponse samlAuthenticate( // ----- Endpoint: security.saml_complete_logout /** + * Logout of SAML completely. + * <p> * Verifies the logout response sent from the SAML IdP. * * @see <a href= @@ -1993,6 +2234,8 @@ public BooleanResponse samlCompleteLogout(SamlCompleteLogoutRequest request) } /** + * Logout of SAML completely. + * <p> * Verifies the logout response sent from the SAML IdP. * * @param fn @@ -2012,6 +2255,8 @@ public final BooleanResponse samlCompleteLogout( // ----- Endpoint: security.saml_invalidate /** + * Invalidate SAML. + * <p> * Submits a SAML LogoutRequest message to Elasticsearch for consumption. * * @see <a href= @@ -2028,6 +2273,8 @@ public SamlInvalidateResponse samlInvalidate(SamlInvalidateRequest request) } /** + * Invalidate SAML. + * <p> * Submits a SAML LogoutRequest message to Elasticsearch for consumption. * * @param fn @@ -2047,6 +2294,8 @@ public final SamlInvalidateResponse samlInvalidate( // ----- Endpoint: security.saml_logout /** + * Logout of SAML. + * <p> * Submits a request to invalidate an access token and refresh token. * * @see <a href= @@ -2062,6 +2311,8 @@ public SamlLogoutResponse samlLogout(SamlLogoutRequest request) throws IOExcepti } /** + * Logout of SAML. + * <p> * Submits a request to invalidate an access token and refresh token. * * @param fn @@ -2080,8 +2331,11 @@ public final SamlLogoutResponse samlLogout(Function<SamlLogoutRequest.Builder, O // ----- Endpoint: security.saml_prepare_authentication /** - * Creates a SAML authentication request (<AuthnRequest>) as a URL string, - * based on the configuration of the respective SAML realm in Elasticsearch. + * Prepare SAML authentication. + * <p> + * Creates a SAML authentication request (<code><AuthnRequest></code>) as + * a URL string, based on the configuration of the respective SAML realm in + * Elasticsearch. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-prepare-authentication.html">Documentation @@ -2097,8 +2351,11 @@ public SamlPrepareAuthenticationResponse samlPrepareAuthentication(SamlPrepareAu } /** - * Creates a SAML authentication request (<AuthnRequest>) as a URL string, - * based on the configuration of the respective SAML realm in Elasticsearch. + * Prepare SAML authentication. + * <p> + * Creates a SAML authentication request (<code><AuthnRequest></code>) as + * a URL string, based on the configuration of the respective SAML realm in + * Elasticsearch. * * @param fn * a function that initializes a builder to create the @@ -2115,8 +2372,11 @@ public final SamlPrepareAuthenticationResponse samlPrepareAuthentication( } /** - * Creates a SAML authentication request (<AuthnRequest>) as a URL string, - * based on the configuration of the respective SAML realm in Elasticsearch. + * Prepare SAML authentication. + * <p> + * Creates a SAML authentication request (<code><AuthnRequest></code>) as + * a URL string, based on the configuration of the respective SAML realm in + * Elasticsearch. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-prepare-authentication.html">Documentation @@ -2131,6 +2391,8 @@ public SamlPrepareAuthenticationResponse samlPrepareAuthentication() throws IOEx // ----- Endpoint: security.saml_service_provider_metadata /** + * Create SAML service provider metadata. + * <p> * Generate SAML metadata for a SAML 2.0 Service Provider. * * @see <a href= @@ -2147,6 +2409,8 @@ public SamlServiceProviderMetadataResponse samlServiceProviderMetadata(SamlServi } /** + * Create SAML service provider metadata. + * <p> * Generate SAML metadata for a SAML 2.0 Service Provider. * * @param fn @@ -2166,6 +2430,8 @@ public final SamlServiceProviderMetadataResponse samlServiceProviderMetadata( // ----- Endpoint: security.suggest_user_profiles /** + * Suggest a user profile. + * <p> * Get suggestions for user profiles that match specified search criteria. * * @see <a href= @@ -2182,6 +2448,8 @@ public SuggestUserProfilesResponse suggestUserProfiles(SuggestUserProfilesReques } /** + * Suggest a user profile. + * <p> * Get suggestions for user profiles that match specified search criteria. * * @param fn @@ -2199,6 +2467,8 @@ public final SuggestUserProfilesResponse suggestUserProfiles( } /** + * Suggest a user profile. + * <p> * Get suggestions for user profiles that match specified search criteria. * * @see <a href= @@ -2214,22 +2484,24 @@ public SuggestUserProfilesResponse suggestUserProfiles() throws IOException, Ela // ----- Endpoint: security.update_api_key /** - * Update an API key. Updates attributes of an existing API key. Users can only - * update API keys that they created or that were granted to them. Use this API - * to update API keys created by the create API Key or grant API Key APIs. If - * you need to apply the same update to many API keys, you can use bulk update - * API Keys to reduce overhead. It’s not possible to update expired API keys, or - * API keys that have been invalidated by invalidate API Key. This API supports - * updates to an API key’s access scope and metadata. The access scope of an API - * key is derived from the <code>role_descriptors</code> you specify in the - * request, and a snapshot of the owner user’s permissions at the time of the - * request. The snapshot of the owner’s permissions is updated automatically on - * every call. If you don’t specify <code>role_descriptors</code> in the - * request, a call to this API might still change the API key’s access scope. - * This change can occur if the owner user’s permissions have changed since the - * API key was created or last modified. To update another user’s API key, use - * the <code>run_as</code> feature to submit a request on behalf of another - * user. IMPORTANT: It’s not possible to use an API key as the authentication + * Update an API key. + * <p> + * Updates attributes of an existing API key. Users can only update API keys + * that they created or that were granted to them. Use this API to update API + * keys created by the create API Key or grant API Key APIs. If you need to + * apply the same update to many API keys, you can use bulk update API Keys to + * reduce overhead. It’s not possible to update expired API keys, or API keys + * that have been invalidated by invalidate API Key. This API supports updates + * to an API key’s access scope and metadata. The access scope of an API key is + * derived from the <code>role_descriptors</code> you specify in the request, + * and a snapshot of the owner user’s permissions at the time of the request. + * The snapshot of the owner’s permissions is updated automatically on every + * call. If you don’t specify <code>role_descriptors</code> in the request, a + * call to this API might still change the API key’s access scope. This change + * can occur if the owner user’s permissions have changed since the API key was + * created or last modified. To update another user’s API key, use the + * <code>run_as</code> feature to submit a request on behalf of another user. + * IMPORTANT: It’s not possible to use an API key as the authentication * credential for this API. To update an API key, the owner user’s credentials * are required. * @@ -2246,22 +2518,24 @@ public UpdateApiKeyResponse updateApiKey(UpdateApiKeyRequest request) throws IOE } /** - * Update an API key. Updates attributes of an existing API key. Users can only - * update API keys that they created or that were granted to them. Use this API - * to update API keys created by the create API Key or grant API Key APIs. If - * you need to apply the same update to many API keys, you can use bulk update - * API Keys to reduce overhead. It’s not possible to update expired API keys, or - * API keys that have been invalidated by invalidate API Key. This API supports - * updates to an API key’s access scope and metadata. The access scope of an API - * key is derived from the <code>role_descriptors</code> you specify in the - * request, and a snapshot of the owner user’s permissions at the time of the - * request. The snapshot of the owner’s permissions is updated automatically on - * every call. If you don’t specify <code>role_descriptors</code> in the - * request, a call to this API might still change the API key’s access scope. - * This change can occur if the owner user’s permissions have changed since the - * API key was created or last modified. To update another user’s API key, use - * the <code>run_as</code> feature to submit a request on behalf of another - * user. IMPORTANT: It’s not possible to use an API key as the authentication + * Update an API key. + * <p> + * Updates attributes of an existing API key. Users can only update API keys + * that they created or that were granted to them. Use this API to update API + * keys created by the create API Key or grant API Key APIs. If you need to + * apply the same update to many API keys, you can use bulk update API Keys to + * reduce overhead. It’s not possible to update expired API keys, or API keys + * that have been invalidated by invalidate API Key. This API supports updates + * to an API key’s access scope and metadata. The access scope of an API key is + * derived from the <code>role_descriptors</code> you specify in the request, + * and a snapshot of the owner user’s permissions at the time of the request. + * The snapshot of the owner’s permissions is updated automatically on every + * call. If you don’t specify <code>role_descriptors</code> in the request, a + * call to this API might still change the API key’s access scope. This change + * can occur if the owner user’s permissions have changed since the API key was + * created or last modified. To update another user’s API key, use the + * <code>run_as</code> feature to submit a request on behalf of another user. + * IMPORTANT: It’s not possible to use an API key as the authentication * credential for this API. To update an API key, the owner user’s credentials * are required. * @@ -2282,8 +2556,10 @@ public final UpdateApiKeyResponse updateApiKey( // ----- Endpoint: security.update_user_profile_data /** - * Updates specific data for the user profile that's associated with the - * specified unique ID. + * Update user profile data. + * <p> + * Update specific data for the user profile that is associated with a unique + * ID. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-user-profile-data.html">Documentation @@ -2299,8 +2575,10 @@ public UpdateUserProfileDataResponse updateUserProfileData(UpdateUserProfileData } /** - * Updates specific data for the user profile that's associated with the - * specified unique ID. + * Update user profile data. + * <p> + * Update specific data for the user profile that is associated with a unique + * ID. * * @param fn * a function that initializes a builder to create the diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/EnableUserProfileRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/EnableUserProfileRequest.java index 580bbcbc9..0e4b496a6 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/EnableUserProfileRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/EnableUserProfileRequest.java @@ -56,7 +56,9 @@ // typedef: security.enable_user_profile.Request /** - * Enables a user profile so it's visible in user profile searches. + * Enable a user profile. + * <p> + * Enable user profiles to make them visible in user profile searches. * * @see <a href= * "../doc-files/api-spec.html#security.enable_user_profile.Request">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/EnableUserRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/EnableUserRequest.java index 070414176..ad1101c67 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/EnableUserRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/EnableUserRequest.java @@ -56,7 +56,9 @@ // typedef: security.enable_user.Request /** - * Enables users in the native realm. + * Enable users. + * <p> + * Enable users in the native realm. * * @see <a href="../doc-files/api-spec.html#security.enable_user.Request">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/EnrollKibanaRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/EnrollKibanaRequest.java index 619c539c7..1335a607b 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/EnrollKibanaRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/EnrollKibanaRequest.java @@ -50,8 +50,10 @@ // typedef: security.enroll_kibana.Request /** - * Enables a Kibana instance to configure itself for communication with a - * secured Elasticsearch cluster. + * Enroll Kibana. + * <p> + * Enable a Kibana instance to configure itself for communication with a secured + * Elasticsearch cluster. * * @see <a href="../doc-files/api-spec.html#security.enroll_kibana.Request">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/EnrollNodeRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/EnrollNodeRequest.java index 6c28b50c3..0f7afec0f 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/EnrollNodeRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/EnrollNodeRequest.java @@ -50,7 +50,10 @@ // typedef: security.enroll_node.Request /** - * Allows a new node to join an existing cluster with security features enabled. + * Enroll a node. + * <p> + * Enroll a new node to allow it to join an existing cluster with security + * features enabled. * * @see <a href="../doc-files/api-spec.html#security.enroll_node.Request">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetApiKeyRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetApiKeyRequest.java index 73e424c8c..8dde456df 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetApiKeyRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetApiKeyRequest.java @@ -56,12 +56,14 @@ // typedef: security.get_api_key.Request /** - * Get API key information. Retrieves information for one or more API keys. - * NOTE: If you have only the <code>manage_own_api_key</code> privilege, this - * API returns only the API keys that you own. If you have - * <code>read_security</code>, <code>manage_api_key</code> or greater privileges - * (including <code>manage_security</code>), this API returns all API keys - * regardless of ownership. + * Get API key information. + * <p> + * Retrieves information for one or more API keys. NOTE: If you have only the + * <code>manage_own_api_key</code> privilege, this API returns only the API keys + * that you own. If you have <code>read_security</code>, + * <code>manage_api_key</code> or greater privileges (including + * <code>manage_security</code>), this API returns all API keys regardless of + * ownership. * * @see <a href="../doc-files/api-spec.html#security.get_api_key.Request">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetBuiltinPrivilegesRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetBuiltinPrivilegesRequest.java index 5489ec422..9af8e46ab 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetBuiltinPrivilegesRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetBuiltinPrivilegesRequest.java @@ -50,8 +50,10 @@ // typedef: security.get_builtin_privileges.Request /** - * Retrieves the list of cluster privileges and index privileges that are - * available in this version of Elasticsearch. + * Get builtin privileges. + * <p> + * Get the list of cluster privileges and index privileges that are available in + * this version of Elasticsearch. * * @see <a href= * "../doc-files/api-spec.html#security.get_builtin_privileges.Request">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetPrivilegesRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetPrivilegesRequest.java index 8124ab49f..c12f59e36 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetPrivilegesRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetPrivilegesRequest.java @@ -58,7 +58,7 @@ // typedef: security.get_privileges.Request /** - * Retrieves application privileges. + * Get application privileges. * * @see <a href="../doc-files/api-spec.html#security.get_privileges.Request">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetRoleMappingRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetRoleMappingRequest.java index ca0bacf24..dcd36c31b 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetRoleMappingRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetRoleMappingRequest.java @@ -58,7 +58,12 @@ // typedef: security.get_role_mapping.Request /** - * Retrieves role mappings. + * Get role mappings. + * <p> + * Role mappings define which roles are assigned to each user. The role mapping + * APIs are generally the preferred way to manage role mappings rather than + * using role mapping files. The get role mappings API cannot retrieve role + * mappings that are defined in role mapping files. * * @see <a href= * "../doc-files/api-spec.html#security.get_role_mapping.Request">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetRoleRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetRoleRequest.java index 30fb124c1..aecf52d33 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetRoleRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetRoleRequest.java @@ -58,9 +58,11 @@ // typedef: security.get_role.Request /** - * The role management APIs are generally the preferred way to manage roles, - * rather than using file-based role management. The get roles API cannot - * retrieve roles that are defined in roles files. + * Get roles. + * <p> + * Get roles in the native realm. The role management APIs are generally the + * preferred way to manage roles, rather than using file-based role management. + * The get roles API cannot retrieve roles that are defined in roles files. * * @see <a href="../doc-files/api-spec.html#security.get_role.Request">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetServiceAccountsRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetServiceAccountsRequest.java index ee3296530..fa2fa48bd 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetServiceAccountsRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetServiceAccountsRequest.java @@ -55,8 +55,9 @@ // typedef: security.get_service_accounts.Request /** - * This API returns a list of service accounts that match the provided path - * parameter(s). + * Get service accounts. + * <p> + * Get a list of service accounts that match the provided path parameters. * * @see <a href= * "../doc-files/api-spec.html#security.get_service_accounts.Request">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetServiceCredentialsRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetServiceCredentialsRequest.java index c6ba0bca5..60fc10153 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetServiceCredentialsRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetServiceCredentialsRequest.java @@ -56,7 +56,7 @@ // typedef: security.get_service_credentials.Request /** - * Retrieves information of all service credentials for a service account. + * Get service account credentials. * * @see <a href= * "../doc-files/api-spec.html#security.get_service_credentials.Request">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetTokenRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetTokenRequest.java index f2916572c..6bcac00cd 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetTokenRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetTokenRequest.java @@ -56,7 +56,9 @@ // typedef: security.get_token.Request /** - * Creates a bearer token for access without requiring basic authentication. + * Get a token. + * <p> + * Create a bearer token for access without requiring basic authentication. * * @see <a href="../doc-files/api-spec.html#security.get_token.Request">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetUserPrivilegesRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetUserPrivilegesRequest.java index 14e30351b..0648dec1d 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetUserPrivilegesRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetUserPrivilegesRequest.java @@ -55,7 +55,7 @@ // typedef: security.get_user_privileges.Request /** - * Retrieves security privileges for the logged in user. + * Get user privileges. * * @see <a href= * "../doc-files/api-spec.html#security.get_user_privileges.Request">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetUserProfileRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetUserProfileRequest.java index d9de3be35..895c5d578 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetUserProfileRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetUserProfileRequest.java @@ -57,7 +57,9 @@ // typedef: security.get_user_profile.Request /** - * Retrieves a user's profile using the unique profile ID. + * Get a user profile. + * <p> + * Get a user's profile using the unique profile ID. * * @see <a href= * "../doc-files/api-spec.html#security.get_user_profile.Request">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetUserRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetUserRequest.java index 3fb19f45c..0af7fb0ac 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetUserRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GetUserRequest.java @@ -58,7 +58,9 @@ // typedef: security.get_user.Request /** - * Retrieves information about users in the native realm and built-in users. + * Get users. + * <p> + * Get information about users in the native realm and built-in users. * * @see <a href="../doc-files/api-spec.html#security.get_user.Request">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GrantApiKeyRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GrantApiKeyRequest.java index d412ddf6d..6b7d38048 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GrantApiKeyRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/GrantApiKeyRequest.java @@ -58,15 +58,17 @@ // typedef: security.grant_api_key.Request /** - * Creates an API key on behalf of another user. This API is similar to Create - * API keys, however it creates the API key for a user that is different than - * the user that runs the API. The caller must have authentication credentials - * (either an access token, or a username and password) for the user on whose - * behalf the API key will be created. It is not possible to use this API to - * create an API key without that user’s credentials. The user, for whom the - * authentication credentials is provided, can optionally "run as" - * (impersonate) another user. In this case, the API key will be created on - * behalf of the impersonated user. + * Grant an API key. + * <p> + * Create an API key on behalf of another user. This API is similar to the + * create API keys API, however it creates the API key for a user that is + * different than the user that runs the API. The caller must have + * authentication credentials (either an access token, or a username and + * password) for the user on whose behalf the API key will be created. It is not + * possible to use this API to create an API key without that user’s + * credentials. The user, for whom the authentication credentials is provided, + * can optionally "run as" (impersonate) another user. In this case, + * the API key will be created on behalf of the impersonated user. * <p> * This API is intended be used by applications that need to create and manage * API keys for end users, but cannot guarantee that those users have permission diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/HasPrivilegesRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/HasPrivilegesRequest.java index 31cac70f8..cd61ed5a1 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/HasPrivilegesRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/HasPrivilegesRequest.java @@ -61,8 +61,9 @@ // typedef: security.has_privileges.Request /** - * Check user privileges. Determines whether the specified user has a specified - * list of privileges. + * Check user privileges. + * <p> + * Determine whether the specified user has a specified list of privileges. * * @see <a href="../doc-files/api-spec.html#security.has_privileges.Request">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/HasPrivilegesUserProfileRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/HasPrivilegesUserProfileRequest.java index 0fe5fa138..60ddf80e4 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/HasPrivilegesUserProfileRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/HasPrivilegesUserProfileRequest.java @@ -58,8 +58,10 @@ // typedef: security.has_privileges_user_profile.Request /** - * Determines whether the users associated with the specified profile IDs have - * all the requested privileges. + * Check user profile privileges. + * <p> + * Determine whether the users associated with the specified user profile IDs + * have all the requested privileges. * * @see <a href= * "../doc-files/api-spec.html#security.has_privileges_user_profile.Request">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/InvalidateApiKeyRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/InvalidateApiKeyRequest.java index 6ff032513..aad803147 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/InvalidateApiKeyRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/InvalidateApiKeyRequest.java @@ -58,8 +58,13 @@ // typedef: security.invalidate_api_key.Request /** - * Invalidate API keys. Invalidates one or more API keys. The - * <code>manage_api_key</code> privilege allows deleting any API keys. The + * Invalidate API keys. + * <p> + * This API invalidates API keys created by the create API key or grant API key + * APIs. Invalidated API keys fail authentication, but they can still be viewed + * using the get API key information and query API key information APIs, for at + * least the configured retention period, until they are automatically deleted. + * The <code>manage_api_key</code> privilege allows deleting any API keys. The * <code>manage_own_api_key</code> only allows deleting API keys that are owned * by the user. In addition, with the <code>manage_own_api_key</code> privilege, * an invalidation request must be issued in one of the three formats: @@ -67,8 +72,8 @@ * <li>Set the parameter <code>owner=true</code>.</li> * <li>Or, set both <code>username</code> and <code>realm_name</code> to match * the user’s identity.</li> - * <li>Or, if the request is issued by an API key, i.e. an API key invalidates - * itself, specify its ID in the <code>ids</code> field.</li> + * <li>Or, if the request is issued by an API key, that is to say an API key + * invalidates itself, specify its ID in the <code>ids</code> field.</li> * </ul> * * @see <a href= diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/InvalidateTokenRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/InvalidateTokenRequest.java index 9f5443643..595637ec5 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/InvalidateTokenRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/InvalidateTokenRequest.java @@ -55,7 +55,16 @@ // typedef: security.invalidate_token.Request /** - * Invalidates one or more access tokens or refresh tokens. + * Invalidate a token. + * <p> + * The access tokens returned by the get token API have a finite period of time + * for which they are valid. After that time period, they can no longer be used. + * The time period is defined by the + * <code>xpack.security.authc.token.timeout</code> setting. + * <p> + * The refresh tokens returned by the get token API are only valid for 24 hours. + * They can also be used exactly once. If you want to invalidate one or more + * access or refresh tokens immediately, use this invalidate token API. * * @see <a href= * "../doc-files/api-spec.html#security.invalidate_token.Request">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/PutPrivilegesRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/PutPrivilegesRequest.java index b189946e3..31efa457f 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/PutPrivilegesRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/PutPrivilegesRequest.java @@ -61,7 +61,7 @@ // typedef: security.put_privileges.Request /** - * Adds or updates application privileges. + * Create or update application privileges. * * @see <a href="../doc-files/api-spec.html#security.put_privileges.Request">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/PutRoleMappingRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/PutRoleMappingRequest.java index 392e380eb..2d7e02733 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/PutRoleMappingRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/PutRoleMappingRequest.java @@ -61,7 +61,17 @@ // typedef: security.put_role_mapping.Request /** - * Creates and updates role mappings. + * Create or update role mappings. + * <p> + * Role mappings define which roles are assigned to each user. Each mapping has + * rules that identify users and a list of roles that are granted to those + * users. The role mapping APIs are generally the preferred way to manage role + * mappings rather than using role mapping files. The create or update role + * mappings API cannot update role mappings that are defined in role mapping + * files. + * <p> + * This API does not create roles. Rather, it maps users to existing roles. + * Roles can be created by using the create or update roles API or roles files. * * @see <a href= * "../doc-files/api-spec.html#security.put_role_mapping.Request">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/PutRoleRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/PutRoleRequest.java index 30d6fa7b9..cca1ea112 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/PutRoleRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/PutRoleRequest.java @@ -60,9 +60,12 @@ // typedef: security.put_role.Request /** - * The role management APIs are generally the preferred way to manage roles, - * rather than using file-based role management. The create or update roles API - * cannot update roles that are defined in roles files. + * Create or update roles. + * <p> + * The role management APIs are generally the preferred way to manage roles in + * the native realm, rather than using file-based role management. The create or + * update roles API cannot update roles that are defined in roles files. + * File-based role management is not available in Elastic Serverless. * * @see <a href="../doc-files/api-spec.html#security.put_role.Request">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/PutUserRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/PutUserRequest.java index 46aa7966d..51130ee8d 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/PutUserRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/PutUserRequest.java @@ -61,8 +61,11 @@ // typedef: security.put_user.Request /** - * Adds and updates users in the native realm. These users are commonly referred - * to as native users. + * Create or update users. + * <p> + * A password is required for adding a new user but is optional when updating an + * existing user. To change a user’s password without updating any other fields, + * use the change password API. * * @see <a href="../doc-files/api-spec.html#security.put_user.Request">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/QueryApiKeysRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/QueryApiKeysRequest.java index 3be34b900..16a977bfe 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/QueryApiKeysRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/QueryApiKeysRequest.java @@ -66,8 +66,10 @@ // typedef: security.query_api_keys.Request /** - * Query API keys. Retrieves a paginated list of API keys and their information. - * You can optionally filter the results with a query. + * Find API keys with a query. + * <p> + * Get a paginated list of API keys and their information. You can optionally + * filter the results with a query. * * @see <a href="../doc-files/api-spec.html#security.query_api_keys.Request">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/QueryRoleRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/QueryRoleRequest.java index fb6d185d8..218f16b9f 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/QueryRoleRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/QueryRoleRequest.java @@ -61,8 +61,10 @@ // typedef: security.query_role.Request /** - * Retrieves roles in a paginated manner. You can optionally filter the results - * with a query. + * Find roles with a query. + * <p> + * Get roles in a paginated manner. You can optionally filter the results with a + * query. * * @see <a href="../doc-files/api-spec.html#security.query_role.Request">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/QueryUserRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/QueryUserRequest.java index 5ad39c13b..beb95376c 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/QueryUserRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/QueryUserRequest.java @@ -64,8 +64,10 @@ // typedef: security.query_user.Request /** - * Retrieves information for Users in a paginated manner. You can optionally - * filter the results with a query. + * Find users with a query. + * <p> + * Get information for users in a paginated manner. You can optionally filter + * the results with a query. * * @see <a href="../doc-files/api-spec.html#security.query_user.Request">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/SamlAuthenticateRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/SamlAuthenticateRequest.java index 77e887782..0c8e9d964 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/SamlAuthenticateRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/SamlAuthenticateRequest.java @@ -57,7 +57,9 @@ // typedef: security.saml_authenticate.Request /** - * Submits a SAML Response message to Elasticsearch for consumption. + * Authenticate SAML. + * <p> + * Submits a SAML response message to Elasticsearch for consumption. * * @see <a href= * "../doc-files/api-spec.html#security.saml_authenticate.Request">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/SamlCompleteLogoutRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/SamlCompleteLogoutRequest.java index ca4af24b6..8aec637c2 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/SamlCompleteLogoutRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/SamlCompleteLogoutRequest.java @@ -59,6 +59,8 @@ // typedef: security.saml_complete_logout.Request /** + * Logout of SAML completely. + * <p> * Verifies the logout response sent from the SAML IdP. * * @see <a href= diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/SamlInvalidateRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/SamlInvalidateRequest.java index 3696211aa..182d00cad 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/SamlInvalidateRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/SamlInvalidateRequest.java @@ -56,6 +56,8 @@ // typedef: security.saml_invalidate.Request /** + * Invalidate SAML. + * <p> * Submits a SAML LogoutRequest message to Elasticsearch for consumption. * * @see <a href= diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/SamlLogoutRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/SamlLogoutRequest.java index f7419a44b..7bad47af3 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/SamlLogoutRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/SamlLogoutRequest.java @@ -56,6 +56,8 @@ // typedef: security.saml_logout.Request /** + * Logout of SAML. + * <p> * Submits a request to invalidate an access token and refresh token. * * @see <a href="../doc-files/api-spec.html#security.saml_logout.Request">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/SamlPrepareAuthenticationRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/SamlPrepareAuthenticationRequest.java index 4609f7093..5b9bdab57 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/SamlPrepareAuthenticationRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/SamlPrepareAuthenticationRequest.java @@ -55,8 +55,11 @@ // typedef: security.saml_prepare_authentication.Request /** - * Creates a SAML authentication request (<AuthnRequest>) as a URL string, - * based on the configuration of the respective SAML realm in Elasticsearch. + * Prepare SAML authentication. + * <p> + * Creates a SAML authentication request (<code><AuthnRequest></code>) as + * a URL string, based on the configuration of the respective SAML realm in + * Elasticsearch. * * @see <a href= * "../doc-files/api-spec.html#security.saml_prepare_authentication.Request">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/SamlServiceProviderMetadataRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/SamlServiceProviderMetadataRequest.java index fe0e9443d..0526e4834 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/SamlServiceProviderMetadataRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/SamlServiceProviderMetadataRequest.java @@ -56,6 +56,8 @@ // typedef: security.saml_service_provider_metadata.Request /** + * Create SAML service provider metadata. + * <p> * Generate SAML metadata for a SAML 2.0 Service Provider. * * @see <a href= diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/SuggestUserProfilesRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/SuggestUserProfilesRequest.java index 2ecc820ae..8ff89a04b 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/SuggestUserProfilesRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/SuggestUserProfilesRequest.java @@ -59,6 +59,8 @@ // typedef: security.suggest_user_profiles.Request /** + * Suggest a user profile. + * <p> * Get suggestions for user profiles that match specified search criteria. * * @see <a href= diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/UpdateApiKeyRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/UpdateApiKeyRequest.java index 63918d8b3..62ff373df 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/UpdateApiKeyRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/UpdateApiKeyRequest.java @@ -60,22 +60,24 @@ // typedef: security.update_api_key.Request /** - * Update an API key. Updates attributes of an existing API key. Users can only - * update API keys that they created or that were granted to them. Use this API - * to update API keys created by the create API Key or grant API Key APIs. If - * you need to apply the same update to many API keys, you can use bulk update - * API Keys to reduce overhead. It’s not possible to update expired API keys, or - * API keys that have been invalidated by invalidate API Key. This API supports - * updates to an API key’s access scope and metadata. The access scope of an API - * key is derived from the <code>role_descriptors</code> you specify in the - * request, and a snapshot of the owner user’s permissions at the time of the - * request. The snapshot of the owner’s permissions is updated automatically on - * every call. If you don’t specify <code>role_descriptors</code> in the - * request, a call to this API might still change the API key’s access scope. - * This change can occur if the owner user’s permissions have changed since the - * API key was created or last modified. To update another user’s API key, use - * the <code>run_as</code> feature to submit a request on behalf of another - * user. IMPORTANT: It’s not possible to use an API key as the authentication + * Update an API key. + * <p> + * Updates attributes of an existing API key. Users can only update API keys + * that they created or that were granted to them. Use this API to update API + * keys created by the create API Key or grant API Key APIs. If you need to + * apply the same update to many API keys, you can use bulk update API Keys to + * reduce overhead. It’s not possible to update expired API keys, or API keys + * that have been invalidated by invalidate API Key. This API supports updates + * to an API key’s access scope and metadata. The access scope of an API key is + * derived from the <code>role_descriptors</code> you specify in the request, + * and a snapshot of the owner user’s permissions at the time of the request. + * The snapshot of the owner’s permissions is updated automatically on every + * call. If you don’t specify <code>role_descriptors</code> in the request, a + * call to this API might still change the API key’s access scope. This change + * can occur if the owner user’s permissions have changed since the API key was + * created or last modified. To update another user’s API key, use the + * <code>run_as</code> feature to submit a request on behalf of another user. + * IMPORTANT: It’s not possible to use an API key as the authentication * credential for this API. To update an API key, the owner user’s credentials * are required. * diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/UpdateUserProfileDataRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/UpdateUserProfileDataRequest.java index 1c95a1aa5..83a234b9d 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/UpdateUserProfileDataRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/UpdateUserProfileDataRequest.java @@ -60,8 +60,10 @@ // typedef: security.update_user_profile_data.Request /** - * Updates specific data for the user profile that's associated with the - * specified unique ID. + * Update user profile data. + * <p> + * Update specific data for the user profile that is associated with a unique + * ID. * * @see <a href= * "../doc-files/api-spec.html#security.update_user_profile_data.Request">API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ssl/CertificatesRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ssl/CertificatesRequest.java index 2d635b689..7873ecbf7 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ssl/CertificatesRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ssl/CertificatesRequest.java @@ -50,8 +50,36 @@ // typedef: ssl.certificates.Request /** - * Retrieves information about the X.509 certificates used to encrypt - * communications in the cluster. + * Get SSL certificates. + * <p> + * Get information about the X.509 certificates that are used to encrypt + * communications in the cluster. The API returns a list that includes + * certificates from all TLS contexts including: + * <ul> + * <li>Settings for transport and HTTP interfaces</li> + * <li>TLS settings that are used within authentication realms</li> + * <li>TLS settings for remote monitoring exporters</li> + * </ul> + * <p> + * The list includes certificates that are used for configuring trust, such as + * those configured in the <code>xpack.security.transport.ssl.truststore</code> + * and <code>xpack.security.transport.ssl.certificate_authorities</code> + * settings. It also includes certificates that are used for configuring server + * identity, such as <code>xpack.security.http.ssl.keystore</code> and + * <code>xpack.security.http.ssl.certificate settings</code>. + * <p> + * The list does not include certificates that are sourced from the default SSL + * context of the Java Runtime Environment (JRE), even if those certificates are + * in use within Elasticsearch. + * <p> + * NOTE: When a PKCS#11 token is configured as the truststore of the JRE, the + * API returns all the certificates that are included in the PKCS#11 token + * irrespective of whether these are used in the Elasticsearch TLS + * configuration. + * <p> + * If Elasticsearch is configured to use a keystore or truststore, the API + * output includes all certificates in that store, even though some of the + * certificates might not be in active use within the cluster. * * @see <a href="../doc-files/api-spec.html#ssl.certificates.Request">API * specification</a> diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ssl/ElasticsearchSslAsyncClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ssl/ElasticsearchSslAsyncClient.java index ba2a85955..c4cc769e8 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ssl/ElasticsearchSslAsyncClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ssl/ElasticsearchSslAsyncClient.java @@ -65,8 +65,36 @@ public ElasticsearchSslAsyncClient withTransportOptions(@Nullable TransportOptio // ----- Endpoint: ssl.certificates /** - * Retrieves information about the X.509 certificates used to encrypt - * communications in the cluster. + * Get SSL certificates. + * <p> + * Get information about the X.509 certificates that are used to encrypt + * communications in the cluster. The API returns a list that includes + * certificates from all TLS contexts including: + * <ul> + * <li>Settings for transport and HTTP interfaces</li> + * <li>TLS settings that are used within authentication realms</li> + * <li>TLS settings for remote monitoring exporters</li> + * </ul> + * <p> + * The list includes certificates that are used for configuring trust, such as + * those configured in the <code>xpack.security.transport.ssl.truststore</code> + * and <code>xpack.security.transport.ssl.certificate_authorities</code> + * settings. It also includes certificates that are used for configuring server + * identity, such as <code>xpack.security.http.ssl.keystore</code> and + * <code>xpack.security.http.ssl.certificate settings</code>. + * <p> + * The list does not include certificates that are sourced from the default SSL + * context of the Java Runtime Environment (JRE), even if those certificates are + * in use within Elasticsearch. + * <p> + * NOTE: When a PKCS#11 token is configured as the truststore of the JRE, the + * API returns all the certificates that are included in the PKCS#11 token + * irrespective of whether these are used in the Elasticsearch TLS + * configuration. + * <p> + * If Elasticsearch is configured to use a keystore or truststore, the API + * output includes all certificates in that store, even though some of the + * certificates might not be in active use within the cluster. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-ssl.html">Documentation diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ssl/ElasticsearchSslClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ssl/ElasticsearchSslClient.java index a2b597d3a..cc83cedce 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ssl/ElasticsearchSslClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ssl/ElasticsearchSslClient.java @@ -66,8 +66,36 @@ public ElasticsearchSslClient withTransportOptions(@Nullable TransportOptions tr // ----- Endpoint: ssl.certificates /** - * Retrieves information about the X.509 certificates used to encrypt - * communications in the cluster. + * Get SSL certificates. + * <p> + * Get information about the X.509 certificates that are used to encrypt + * communications in the cluster. The API returns a list that includes + * certificates from all TLS contexts including: + * <ul> + * <li>Settings for transport and HTTP interfaces</li> + * <li>TLS settings that are used within authentication realms</li> + * <li>TLS settings for remote monitoring exporters</li> + * </ul> + * <p> + * The list includes certificates that are used for configuring trust, such as + * those configured in the <code>xpack.security.transport.ssl.truststore</code> + * and <code>xpack.security.transport.ssl.certificate_authorities</code> + * settings. It also includes certificates that are used for configuring server + * identity, such as <code>xpack.security.http.ssl.keystore</code> and + * <code>xpack.security.http.ssl.certificate settings</code>. + * <p> + * The list does not include certificates that are sourced from the default SSL + * context of the Java Runtime Environment (JRE), even if those certificates are + * in use within Elasticsearch. + * <p> + * NOTE: When a PKCS#11 token is configured as the truststore of the JRE, the + * API returns all the certificates that are included in the PKCS#11 token + * irrespective of whether these are used in the Elasticsearch TLS + * configuration. + * <p> + * If Elasticsearch is configured to use a keystore or truststore, the API + * output includes all certificates in that store, even though some of the + * certificates might not be in active use within the cluster. * * @see <a href= * "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-ssl.html">Documentation diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/tasks/ElasticsearchTasksAsyncClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/tasks/ElasticsearchTasksAsyncClient.java index 067e1290a..c7739d9f1 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/tasks/ElasticsearchTasksAsyncClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/tasks/ElasticsearchTasksAsyncClient.java @@ -71,7 +71,7 @@ public ElasticsearchTasksAsyncClient withTransportOptions(@Nullable TransportOpt * Cancels a task, if it can be cancelled through an API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/tasks.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/tasks.html">Documentation * on elastic.co</a> */ @@ -89,7 +89,7 @@ public CompletableFuture<CancelResponse> cancel(CancelRequest request) { * a function that initializes a builder to create the * {@link CancelRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/tasks.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/tasks.html">Documentation * on elastic.co</a> */ @@ -102,7 +102,7 @@ public final CompletableFuture<CancelResponse> cancel( * Cancels a task, if it can be cancelled through an API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/tasks.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/tasks.html">Documentation * on elastic.co</a> */ @@ -118,7 +118,7 @@ public CompletableFuture<CancelResponse> cancel() { * in the cluster. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/tasks.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/tasks.html">Documentation * on elastic.co</a> */ @@ -137,7 +137,7 @@ public CompletableFuture<GetTasksResponse> get(GetTasksRequest request) { * a function that initializes a builder to create the * {@link GetTasksRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/tasks.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/tasks.html">Documentation * on elastic.co</a> */ @@ -153,7 +153,7 @@ public final CompletableFuture<GetTasksResponse> get( * on one or more nodes in the cluster. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/tasks.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/tasks.html">Documentation * on elastic.co</a> */ @@ -172,7 +172,7 @@ public CompletableFuture<ListResponse> list(ListRequest request) { * a function that initializes a builder to create the * {@link ListRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/tasks.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/tasks.html">Documentation * on elastic.co</a> */ @@ -185,7 +185,7 @@ public final CompletableFuture<ListResponse> list(Function<ListRequest.Builder, * on one or more nodes in the cluster. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/tasks.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/tasks.html">Documentation * on elastic.co</a> */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/tasks/ElasticsearchTasksClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/tasks/ElasticsearchTasksClient.java index 3cd43430a..71c3bb26f 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/tasks/ElasticsearchTasksClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/tasks/ElasticsearchTasksClient.java @@ -71,7 +71,7 @@ public ElasticsearchTasksClient withTransportOptions(@Nullable TransportOptions * Cancels a task, if it can be cancelled through an API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/tasks.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/tasks.html">Documentation * on elastic.co</a> */ @@ -89,7 +89,7 @@ public CancelResponse cancel(CancelRequest request) throws IOException, Elastics * a function that initializes a builder to create the * {@link CancelRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/tasks.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/tasks.html">Documentation * on elastic.co</a> */ @@ -102,7 +102,7 @@ public final CancelResponse cancel(Function<CancelRequest.Builder, ObjectBuilder * Cancels a task, if it can be cancelled through an API. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/tasks.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/tasks.html">Documentation * on elastic.co</a> */ @@ -118,7 +118,7 @@ public CancelResponse cancel() throws IOException, ElasticsearchException { * in the cluster. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/tasks.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/tasks.html">Documentation * on elastic.co</a> */ @@ -137,7 +137,7 @@ public GetTasksResponse get(GetTasksRequest request) throws IOException, Elastic * a function that initializes a builder to create the * {@link GetTasksRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/tasks.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/tasks.html">Documentation * on elastic.co</a> */ @@ -153,7 +153,7 @@ public final GetTasksResponse get(Function<GetTasksRequest.Builder, ObjectBuilde * on one or more nodes in the cluster. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/tasks.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/tasks.html">Documentation * on elastic.co</a> */ @@ -172,7 +172,7 @@ public ListResponse list(ListRequest request) throws IOException, ElasticsearchE * a function that initializes a builder to create the * {@link ListRequest} * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/tasks.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/tasks.html">Documentation * on elastic.co</a> */ @@ -186,7 +186,7 @@ public final ListResponse list(Function<ListRequest.Builder, ObjectBuilder<ListR * on one or more nodes in the cluster. * * @see <a href= - * "https://www.elastic.co/guide/en/elasticsearch/reference/8.16/tasks.html">Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/tasks.html">Documentation * on elastic.co</a> */