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 aa48413c8..f4f0eac96 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 @@ -403,7 +403,9 @@ public CompletableFuture bulk() { // ----- Endpoint: clear_scroll /** - * Clears the search context and results for a scrolling search. + * Clear a scrolling search. + *

+ * Clear the search context and results for a scrolling search. * * @see Documentation @@ -418,7 +420,9 @@ public CompletableFuture clearScroll(ClearScrollRequest req } /** - * Clears the search context and results for a scrolling search. + * Clear a scrolling search. + *

+ * Clear the search context and results for a scrolling search. * * @param fn * a function that initializes a builder to create the @@ -434,7 +438,9 @@ public final CompletableFuture clearScroll( } /** - * Clears the search context and results for a scrolling search. + * Clear a scrolling search. + *

+ * Clear the search context and results for a scrolling search. * * @see Documentation @@ -449,7 +455,14 @@ public CompletableFuture clearScroll() { // ----- Endpoint: close_point_in_time /** - * Closes a point-in-time. + * Close a point in time. + *

+ * A point in time must be opened explicitly before being used in search + * requests. The keep_alive parameter tells Elasticsearch how long + * it should persist. A point in time is automatically closed when the + * keep_alive period has elapsed. However, keeping points in time + * has a cost; close them as soon as they are no longer required for search + * requests. * * @see Documentation @@ -464,7 +477,14 @@ public CompletableFuture closePointInTime(ClosePointIn } /** - * Closes a point-in-time. + * Close a point in time. + *

+ * A point in time must be opened explicitly before being used in search + * requests. The keep_alive parameter tells Elasticsearch how long + * it should persist. A point in time is automatically closed when the + * keep_alive period has elapsed. However, keeping points in time + * has a cost; close them as soon as they are no longer required for search + * requests. * * @param fn * a function that initializes a builder to create the @@ -631,8 +651,12 @@ public final CompletableFuture deleteByQuery( // ----- Endpoint: delete_by_query_rethrottle /** - * Changes the number of requests per second for a particular Delete By Query - * operation. + * Throttle a delete by query operation. + *

+ * Change the number of requests per second for a particular delete by query + * operation. Rethrottling that speeds up the query takes effect immediately but + * rethrotting that slows down the query takes effect after completing the + * current batch to prevent scroll timeouts. * * @see Documentation @@ -648,8 +672,12 @@ public CompletableFuture deleteByQueryRethrottl } /** - * Changes the number of requests per second for a particular Delete By Query - * operation. + * Throttle a delete by query operation. + *

+ * Change the number of requests per second for a particular delete by query + * operation. Rethrottling that speeds up the query takes effect immediately but + * rethrotting that slows down the query takes effect after completing the + * current batch to prevent scroll timeouts. * * @param fn * a function that initializes a builder to create the @@ -844,11 +872,14 @@ public final CompletableFuture> explain( // ----- Endpoint: field_caps /** - * The field capabilities API returns the information about the capabilities of - * fields among multiple indices. The field capabilities API returns runtime - * fields like any other field. For example, a runtime field with a type of - * keyword is returned as any other field that belongs to the - * keyword family. + * Get the field capabilities. + *

+ * Get information about the capabilities of fields among multiple indices. + *

+ * For data streams, the API returns field capabilities among the stream’s + * backing indices. It returns runtime fields like any other field. For example, + * a runtime field with a type of keyword is returned the same as any other + * field that belongs to the keyword family. * * @see Documentation @@ -863,11 +894,14 @@ public CompletableFuture fieldCaps(FieldCapsRequest request) } /** - * The field capabilities API returns the information about the capabilities of - * fields among multiple indices. The field capabilities API returns runtime - * fields like any other field. For example, a runtime field with a type of - * keyword is returned as any other field that belongs to the - * keyword family. + * Get the field capabilities. + *

+ * Get information about the capabilities of fields among multiple indices. + *

+ * For data streams, the API returns field capabilities among the stream’s + * backing indices. It returns runtime fields like any other field. For example, + * a runtime field with a type of keyword is returned the same as any other + * field that belongs to the keyword family. * * @param fn * a function that initializes a builder to create the @@ -883,11 +917,14 @@ public final CompletableFuture fieldCaps( } /** - * The field capabilities API returns the information about the capabilities of - * fields among multiple indices. The field capabilities API returns runtime - * fields like any other field. For example, a runtime field with a type of - * keyword is returned as any other field that belongs to the - * keyword family. + * Get the field capabilities. + *

+ * Get information about the capabilities of fields among multiple indices. + *

+ * For data streams, the API returns field capabilities among the stream’s + * backing indices. It returns runtime fields like any other field. For example, + * a runtime field with a type of keyword is returned the same as any other + * field that belongs to the keyword family. * * @see Documentation @@ -1210,7 +1247,22 @@ public CompletableFuture info() { // ----- Endpoint: knn_search /** - * Performs a kNN search. + * Run a knn search. + *

+ * NOTE: The kNN search API has been replaced by the knn option in + * the search API. + *

+ * Perform a k-nearest neighbor (kNN) search on a dense_vector field and return + * the matching documents. Given a query vector, the API finds the k closest + * vectors and returns those documents as search hits. + *

+ * Elasticsearch uses the HNSW algorithm to support efficient kNN search. Like + * most kNN algorithms, HNSW is an approximate method that sacrifices result + * accuracy for improved search speed. This means the results returned are not + * always the true k closest neighbors. + *

+ * The kNN search API supports restricting the search using a filter. The search + * will return the top k documents that also match the filter query. * * @see Documentation @@ -1229,7 +1281,22 @@ public CompletableFuture> knnSearch(Knn } /** - * Performs a kNN search. + * Run a knn search. + *

+ * NOTE: The kNN search API has been replaced by the knn option in + * the search API. + *

+ * Perform a k-nearest neighbor (kNN) search on a dense_vector field and return + * the matching documents. Given a query vector, the API finds the k closest + * vectors and returns those documents as search hits. + *

+ * Elasticsearch uses the HNSW algorithm to support efficient kNN search. Like + * most kNN algorithms, HNSW is an approximate method that sacrifices result + * accuracy for improved search speed. This means the results returned are not + * always the true k closest neighbors. + *

+ * The kNN search API supports restricting the search using a filter. The search + * will return the top k documents that also match the filter query. * * @param fn * a function that initializes a builder to create the @@ -1245,7 +1312,22 @@ public final CompletableFuture> knnSear } /** - * Performs a kNN search. + * Run a knn search. + *

+ * NOTE: The kNN search API has been replaced by the knn option in + * the search API. + *

+ * Perform a k-nearest neighbor (kNN) search on a dense_vector field and return + * the matching documents. Given a query vector, the API finds the k closest + * vectors and returns those documents as search hits. + *

+ * Elasticsearch uses the HNSW algorithm to support efficient kNN search. Like + * most kNN algorithms, HNSW is an approximate method that sacrifices result + * accuracy for improved search speed. This means the results returned are not + * always the true k closest neighbors. + *

+ * The kNN search API supports restricting the search using a filter. The search + * will return the top k documents that also match the filter query. * * @see Documentation @@ -1264,7 +1346,22 @@ public CompletableFuture> knnSearch(Knn } /** - * Performs a kNN search. + * Run a knn search. + *

+ * NOTE: The kNN search API has been replaced by the knn option in + * the search API. + *

+ * Perform a k-nearest neighbor (kNN) search on a dense_vector field and return + * the matching documents. Given a query vector, the API finds the k closest + * vectors and returns those documents as search hits. + *

+ * Elasticsearch uses the HNSW algorithm to support efficient kNN search. Like + * most kNN algorithms, HNSW is an approximate method that sacrifices result + * accuracy for improved search speed. This means the results returned are not + * always the true k closest neighbors. + *

+ * The kNN search API supports restricting the search using a filter. The search + * will return the top k documents that also match the filter query. * * @param fn * a function that initializes a builder to create the @@ -1282,7 +1379,12 @@ public final CompletableFuture> knnSear // ----- Endpoint: mget /** - * Allows to get multiple documents in one request. + * Get multiple documents. + *

+ * Get multiple JSON documents by ID from one or more indices. If you specify an + * index in the request URI, you only need to specify the document IDs in the + * request body. To ensure fast responses, this multi get (mget) API responds + * with partial results if one or more shards fail. * * @see Documentation @@ -1300,7 +1402,12 @@ public CompletableFuture> mget(MgetRequest r } /** - * Allows to get multiple documents in one request. + * Get multiple documents. + *

+ * Get multiple JSON documents by ID from one or more indices. If you specify an + * index in the request URI, you only need to specify the document IDs in the + * request body. To ensure fast responses, this multi get (mget) API responds + * with partial results if one or more shards fail. * * @param fn * a function that initializes a builder to create the @@ -1316,7 +1423,12 @@ public final CompletableFuture> mget( } /** - * Allows to get multiple documents in one request. + * Get multiple documents. + *

+ * Get multiple JSON documents by ID from one or more indices. If you specify an + * index in the request URI, you only need to specify the document IDs in the + * request body. To ensure fast responses, this multi get (mget) API responds + * with partial results if one or more shards fail. * * @see Documentation @@ -1333,7 +1445,12 @@ public CompletableFuture> mget(MgetRequest r } /** - * Allows to get multiple documents in one request. + * Get multiple documents. + *

+ * Get multiple JSON documents by ID from one or more indices. If you specify an + * index in the request URI, you only need to specify the document IDs in the + * request body. To ensure fast responses, this multi get (mget) API responds + * with partial results if one or more shards fail. * * @param fn * a function that initializes a builder to create the @@ -1501,7 +1618,7 @@ public final CompletableFuture> msearch( // ----- Endpoint: msearch_template /** - * Runs multiple templated searches with a single request. + * Run multiple templated searches. * * @see Documentation @@ -1520,7 +1637,7 @@ public CompletableFuture> msearch } /** - * Runs multiple templated searches with a single request. + * Run multiple templated searches. * * @param fn * a function that initializes a builder to create the @@ -1537,7 +1654,7 @@ public final CompletableFuture> m } /** - * Runs multiple templated searches with a single request. + * Run multiple templated searches. * * @see Documentation @@ -1556,7 +1673,7 @@ public CompletableFuture> msearch } /** - * Runs multiple templated searches with a single request. + * Run multiple templated searches. * * @param fn * a function that initializes a builder to create the @@ -1574,7 +1691,13 @@ public final CompletableFuture> m // ----- Endpoint: mtermvectors /** - * Returns multiple termvectors in one request. + * Get multiple term vectors. + *

+ * You can specify existing documents by index and ID or provide artificial + * documents in the body of the request. You can specify the index in the + * request body or request URI. The response contains a docs array + * with all the fetched termvectors. Each element has the structure provided by + * the termvectors API. * * @see Documentation @@ -1589,7 +1712,13 @@ public CompletableFuture mtermvectors(MtermvectorsRequest } /** - * Returns multiple termvectors in one request. + * Get multiple term vectors. + *

+ * You can specify existing documents by index and ID or provide artificial + * documents in the body of the request. You can specify the index in the + * request body or request URI. The response contains a docs array + * with all the fetched termvectors. Each element has the structure provided by + * the termvectors API. * * @param fn * a function that initializes a builder to create the @@ -1605,7 +1734,13 @@ public final CompletableFuture mtermvectors( } /** - * Returns multiple termvectors in one request. + * Get multiple term vectors. + *

+ * You can specify existing documents by index and ID or provide artificial + * documents in the body of the request. You can specify the index in the + * request body or request URI. The response contains a docs array + * with all the fetched termvectors. Each element has the structure provided by + * the termvectors API. * * @see Documentation @@ -1620,14 +1755,20 @@ public CompletableFuture mtermvectors() { // ----- Endpoint: open_point_in_time /** - * A search request by default executes against the most recent visible data of - * the target indices, which is called point in time. Elasticsearch pit (point - * in time) is a lightweight view into the state of the data as it existed when + * Open a point in time. + *

+ * A search request by default runs against the most recent visible data of the + * target indices, which is called point in time. Elasticsearch pit (point in + * time) is a lightweight view into the state of the data as it existed when * initiated. In some cases, it’s preferred to perform multiple search requests * using the same point in time. For example, if refreshes happen between * search_after requests, then the results of those requests might * not be consistent as changes happening between searches are only visible to * the more recent point in time. + *

+ * A point in time must be opened explicitly before being used in search + * requests. The keep_alive parameter tells Elasticsearch how long + * it should persist. * * @see Documentation @@ -1642,14 +1783,20 @@ public CompletableFuture openPointInTime(OpenPointInTim } /** - * A search request by default executes against the most recent visible data of - * the target indices, which is called point in time. Elasticsearch pit (point - * in time) is a lightweight view into the state of the data as it existed when + * Open a point in time. + *

+ * A search request by default runs against the most recent visible data of the + * target indices, which is called point in time. Elasticsearch pit (point in + * time) is a lightweight view into the state of the data as it existed when * initiated. In some cases, it’s preferred to perform multiple search requests * using the same point in time. For example, if refreshes happen between * search_after requests, then the results of those requests might * not be consistent as changes happening between searches are only visible to * the more recent point in time. + *

+ * A point in time must be opened explicitly before being used in search + * requests. The keep_alive parameter tells Elasticsearch how long + * it should persist. * * @param fn * a function that initializes a builder to create the @@ -1715,8 +1862,10 @@ public final CompletableFuture putScript( // ----- Endpoint: rank_eval /** - * Enables you to evaluate the quality of ranked search results over a set of - * typical search queries. + * Evaluate ranked search results. + *

+ * Evaluate the quality of ranked search results over a set of typical search + * queries. * * @see Documentation @@ -1731,8 +1880,10 @@ public CompletableFuture rankEval(RankEvalRequest request) { } /** - * Enables you to evaluate the quality of ranked search results over a set of - * typical search queries. + * Evaluate ranked search results. + *

+ * Evaluate the quality of ranked search results over a set of typical search + * queries. * * @param fn * a function that initializes a builder to create the @@ -1789,7 +1940,9 @@ public final CompletableFuture reindex( // ----- Endpoint: reindex_rethrottle /** - * Copies documents from a source to a destination. + * Throttle a reindex operation. + *

+ * Change the number of requests per second for a particular reindex operation. * * @see Documentation @@ -1804,7 +1957,9 @@ public CompletableFuture reindexRethrottle(ReindexRet } /** - * Copies documents from a source to a destination. + * Throttle a reindex operation. + *

+ * Change the number of requests per second for a particular reindex operation. * * @param fn * a function that initializes a builder to create the @@ -1822,7 +1977,9 @@ public final CompletableFuture reindexRethrottle( // ----- Endpoint: render_search_template /** - * Renders a search template as a search request body. + * Render a search template. + *

+ * Render a search template as a search request body. * * @see Documentation @@ -1837,7 +1994,9 @@ public CompletableFuture renderSearchTemplate(Rend } /** - * Renders a search template as a search request body. + * Render a search template. + *

+ * Render a search template as a search request body. * * @param fn * a function that initializes a builder to create the @@ -1853,7 +2012,9 @@ public final CompletableFuture renderSearchTemplat } /** - * Renders a search template as a search request body. + * Render a search template. + *

+ * Render a search template as a search request body. * * @see Documentation @@ -2099,9 +2260,11 @@ public final CompletableFuture> scroll( // ----- Endpoint: search /** - * Returns search hits that match the query defined in the request. You can - * provide search queries using the q query string parameter or the - * request body. If both are specified, only the query parameter is used. + * Run a search. + *

+ * Get search hits that match the query defined in the request. You can provide + * search queries using the q query string parameter or the request + * body. If both are specified, only the query parameter is used. * * @see Documentation @@ -2119,9 +2282,11 @@ public CompletableFuture> search(SearchReq } /** - * Returns search hits that match the query defined in the request. You can - * provide search queries using the q query string parameter or the - * request body. If both are specified, only the query parameter is used. + * Run a search. + *

+ * Get search hits that match the query defined in the request. You can provide + * search queries using the q query string parameter or the request + * body. If both are specified, only the query parameter is used. * * @param fn * a function that initializes a builder to create the @@ -2137,9 +2302,11 @@ public final CompletableFuture> search( } /** - * Returns search hits that match the query defined in the request. You can - * provide search queries using the q query string parameter or the - * request body. If both are specified, only the query parameter is used. + * Run a search. + *

+ * Get search hits that match the query defined in the request. You can provide + * search queries using the q query string parameter or the request + * body. If both are specified, only the query parameter is used. * * @see Documentation @@ -2156,9 +2323,11 @@ public CompletableFuture> search(SearchReq } /** - * Returns search hits that match the query defined in the request. You can - * provide search queries using the q query string parameter or the - * request body. If both are specified, only the query parameter is used. + * Run a search. + *

+ * Get search hits that match the query defined in the request. You can provide + * search queries using the q query string parameter or the request + * body. If both are specified, only the query parameter is used. * * @param fn * a function that initializes a builder to create the @@ -2176,7 +2345,9 @@ public final CompletableFuture> search( // ----- Endpoint: search_mvt /** - * Search a vector tile. Searches a vector tile for geospatial values. + * Search a vector tile. + *

+ * Search a vector tile for geospatial values. * * @see Documentation @@ -2191,7 +2362,9 @@ public CompletableFuture searchMvt(SearchMvtRequest request) { } /** - * Search a vector tile. Searches a vector tile for geospatial values. + * Search a vector tile. + *

+ * Search a vector tile for geospatial values. * * @param fn * a function that initializes a builder to create the @@ -2209,8 +2382,12 @@ public final CompletableFuture searchMvt( // ----- Endpoint: search_shards /** - * Returns information about the indices and shards that a search request would - * be executed against. + * Get the search shards. + *

+ * Get the indices and shards that a search request would be run against. This + * information can be useful for working out issues or planning optimizations + * with routing and shard preferences. When filtered aliases are used, the + * filter is returned as part of the indices section. * * @see Documentation @@ -2225,8 +2402,12 @@ public CompletableFuture searchShards(SearchShardsRequest } /** - * Returns information about the indices and shards that a search request would - * be executed against. + * Get the search shards. + *

+ * Get the indices and shards that a search request would be run against. This + * information can be useful for working out issues or planning optimizations + * with routing and shard preferences. When filtered aliases are used, the + * filter is returned as part of the indices section. * * @param fn * a function that initializes a builder to create the @@ -2242,8 +2423,12 @@ public final CompletableFuture searchShards( } /** - * Returns information about the indices and shards that a search request would - * be executed against. + * Get the search shards. + *

+ * Get the indices and shards that a search request would be run against. This + * information can be useful for working out issues or planning optimizations + * with routing and shard preferences. When filtered aliases are used, the + * filter is returned as part of the indices section. * * @see Documentation @@ -2258,7 +2443,7 @@ public CompletableFuture searchShards() { // ----- Endpoint: search_template /** - * Runs a search with a search template. + * Run a search with a search template. * * @see Documentation @@ -2277,7 +2462,7 @@ public CompletableFuture> searchTe } /** - * Runs a search with a search template. + * Run a search with a search template. * * @param fn * a function that initializes a builder to create the @@ -2294,7 +2479,7 @@ public final CompletableFuture> se } /** - * Runs a search with a search template. + * Run a search with a search template. * * @see Documentation @@ -2313,7 +2498,7 @@ public CompletableFuture> searchTe } /** - * Runs a search with a search template. + * Run a search with a search template. * * @param fn * a function that initializes a builder to create the @@ -2390,8 +2575,10 @@ public final CompletableFuture termsEnum( // ----- Endpoint: termvectors /** - * Get term vector information. Returns information and statistics about terms - * in the fields of a particular document. + * Get term vector information. + *

+ * Get information and statistics about terms in the fields of a particular + * document. * * @see Documentation @@ -2406,8 +2593,10 @@ public CompletableFuture termvectors(Termvector } /** - * Get term vector information. Returns information and statistics about terms - * in the fields of a particular document. + * Get term vector information. + *

+ * Get information and statistics about terms in the fields of a particular + * document. * * @param fn * a function that initializes a builder to create the @@ -2540,8 +2729,12 @@ public final CompletableFuture updateByQuery( // ----- Endpoint: update_by_query_rethrottle /** - * Changes the number of requests per second for a particular Update By Query - * operation. + * Throttle an update by query operation. + *

+ * Change the number of requests per second for a particular update by query + * operation. Rethrottling that speeds up the query takes effect immediately but + * rethrotting that slows down the query takes effect after completing the + * current batch to prevent scroll timeouts. * * @see Documentation @@ -2557,8 +2750,12 @@ public CompletableFuture updateByQueryRethrottl } /** - * Changes the number of requests per second for a particular Update By Query - * operation. + * Throttle an update by query operation. + *

+ * Change the number of requests per second for a particular update by query + * operation. Rethrottling that speeds up the query takes effect immediately but + * rethrotting that slows down the query takes effect after completing the + * current batch to prevent scroll timeouts. * * @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 680d5fc77..6b2b29151 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 @@ -405,7 +405,9 @@ public BulkResponse bulk() throws IOException, ElasticsearchException { // ----- Endpoint: clear_scroll /** - * Clears the search context and results for a scrolling search. + * Clear a scrolling search. + *

+ * Clear the search context and results for a scrolling search. * * @see Documentation @@ -420,7 +422,9 @@ public ClearScrollResponse clearScroll(ClearScrollRequest request) throws IOExce } /** - * Clears the search context and results for a scrolling search. + * Clear a scrolling search. + *

+ * Clear the search context and results for a scrolling search. * * @param fn * a function that initializes a builder to create the @@ -437,7 +441,9 @@ public final ClearScrollResponse clearScroll( } /** - * Clears the search context and results for a scrolling search. + * Clear a scrolling search. + *

+ * Clear the search context and results for a scrolling search. * * @see Documentation @@ -452,7 +458,14 @@ public ClearScrollResponse clearScroll() throws IOException, ElasticsearchExcept // ----- Endpoint: close_point_in_time /** - * Closes a point-in-time. + * Close a point in time. + *

+ * A point in time must be opened explicitly before being used in search + * requests. The keep_alive parameter tells Elasticsearch how long + * it should persist. A point in time is automatically closed when the + * keep_alive period has elapsed. However, keeping points in time + * has a cost; close them as soon as they are no longer required for search + * requests. * * @see Documentation @@ -468,7 +481,14 @@ public ClosePointInTimeResponse closePointInTime(ClosePointInTimeRequest request } /** - * Closes a point-in-time. + * Close a point in time. + *

+ * A point in time must be opened explicitly before being used in search + * requests. The keep_alive parameter tells Elasticsearch how long + * it should persist. A point in time is automatically closed when the + * keep_alive period has elapsed. However, keeping points in time + * has a cost; close them as soon as they are no longer required for search + * requests. * * @param fn * a function that initializes a builder to create the @@ -640,8 +660,12 @@ public final DeleteByQueryResponse deleteByQuery( // ----- Endpoint: delete_by_query_rethrottle /** - * Changes the number of requests per second for a particular Delete By Query - * operation. + * Throttle a delete by query operation. + *

+ * Change the number of requests per second for a particular delete by query + * operation. Rethrottling that speeds up the query takes effect immediately but + * rethrotting that slows down the query takes effect after completing the + * current batch to prevent scroll timeouts. * * @see Documentation @@ -657,8 +681,12 @@ public DeleteByQueryRethrottleResponse deleteByQueryRethrottle(DeleteByQueryReth } /** - * Changes the number of requests per second for a particular Delete By Query - * operation. + * Throttle a delete by query operation. + *

+ * Change the number of requests per second for a particular delete by query + * operation. Rethrottling that speeds up the query takes effect immediately but + * rethrotting that slows down the query takes effect after completing the + * current batch to prevent scroll timeouts. * * @param fn * a function that initializes a builder to create the @@ -858,11 +886,14 @@ public final ExplainResponse explain( // ----- Endpoint: field_caps /** - * The field capabilities API returns the information about the capabilities of - * fields among multiple indices. The field capabilities API returns runtime - * fields like any other field. For example, a runtime field with a type of - * keyword is returned as any other field that belongs to the - * keyword family. + * Get the field capabilities. + *

+ * Get information about the capabilities of fields among multiple indices. + *

+ * For data streams, the API returns field capabilities among the stream’s + * backing indices. It returns runtime fields like any other field. For example, + * a runtime field with a type of keyword is returned the same as any other + * field that belongs to the keyword family. * * @see Documentation @@ -877,11 +908,14 @@ public FieldCapsResponse fieldCaps(FieldCapsRequest request) throws IOException, } /** - * The field capabilities API returns the information about the capabilities of - * fields among multiple indices. The field capabilities API returns runtime - * fields like any other field. For example, a runtime field with a type of - * keyword is returned as any other field that belongs to the - * keyword family. + * Get the field capabilities. + *

+ * Get information about the capabilities of fields among multiple indices. + *

+ * For data streams, the API returns field capabilities among the stream’s + * backing indices. It returns runtime fields like any other field. For example, + * a runtime field with a type of keyword is returned the same as any other + * field that belongs to the keyword family. * * @param fn * a function that initializes a builder to create the @@ -897,11 +931,14 @@ public final FieldCapsResponse fieldCaps(Functionkeyword family. + * Get the field capabilities. + *

+ * Get information about the capabilities of fields among multiple indices. + *

+ * For data streams, the API returns field capabilities among the stream’s + * backing indices. It returns runtime fields like any other field. For example, + * a runtime field with a type of keyword is returned the same as any other + * field that belongs to the keyword family. * * @see Documentation @@ -1229,7 +1266,22 @@ public InfoResponse info() throws IOException, ElasticsearchException { // ----- Endpoint: knn_search /** - * Performs a kNN search. + * Run a knn search. + *

+ * NOTE: The kNN search API has been replaced by the knn option in + * the search API. + *

+ * Perform a k-nearest neighbor (kNN) search on a dense_vector field and return + * the matching documents. Given a query vector, the API finds the k closest + * vectors and returns those documents as search hits. + *

+ * Elasticsearch uses the HNSW algorithm to support efficient kNN search. Like + * most kNN algorithms, HNSW is an approximate method that sacrifices result + * accuracy for improved search speed. This means the results returned are not + * always the true k closest neighbors. + *

+ * The kNN search API supports restricting the search using a filter. The search + * will return the top k documents that also match the filter query. * * @see Documentation @@ -1248,7 +1300,22 @@ public KnnSearchResponse knnSearch(KnnSearchRequest reque } /** - * Performs a kNN search. + * Run a knn search. + *

+ * NOTE: The kNN search API has been replaced by the knn option in + * the search API. + *

+ * Perform a k-nearest neighbor (kNN) search on a dense_vector field and return + * the matching documents. Given a query vector, the API finds the k closest + * vectors and returns those documents as search hits. + *

+ * Elasticsearch uses the HNSW algorithm to support efficient kNN search. Like + * most kNN algorithms, HNSW is an approximate method that sacrifices result + * accuracy for improved search speed. This means the results returned are not + * always the true k closest neighbors. + *

+ * The kNN search API supports restricting the search using a filter. The search + * will return the top k documents that also match the filter query. * * @param fn * a function that initializes a builder to create the @@ -1265,7 +1332,22 @@ public final KnnSearchResponse knnSearch( } /** - * Performs a kNN search. + * Run a knn search. + *

+ * NOTE: The kNN search API has been replaced by the knn option in + * the search API. + *

+ * Perform a k-nearest neighbor (kNN) search on a dense_vector field and return + * the matching documents. Given a query vector, the API finds the k closest + * vectors and returns those documents as search hits. + *

+ * Elasticsearch uses the HNSW algorithm to support efficient kNN search. Like + * most kNN algorithms, HNSW is an approximate method that sacrifices result + * accuracy for improved search speed. This means the results returned are not + * always the true k closest neighbors. + *

+ * The kNN search API supports restricting the search using a filter. The search + * will return the top k documents that also match the filter query. * * @see Documentation @@ -1284,7 +1366,22 @@ public KnnSearchResponse knnSearch(KnnSearchRequest reque } /** - * Performs a kNN search. + * Run a knn search. + *

+ * NOTE: The kNN search API has been replaced by the knn option in + * the search API. + *

+ * Perform a k-nearest neighbor (kNN) search on a dense_vector field and return + * the matching documents. Given a query vector, the API finds the k closest + * vectors and returns those documents as search hits. + *

+ * Elasticsearch uses the HNSW algorithm to support efficient kNN search. Like + * most kNN algorithms, HNSW is an approximate method that sacrifices result + * accuracy for improved search speed. This means the results returned are not + * always the true k closest neighbors. + *

+ * The kNN search API supports restricting the search using a filter. The search + * will return the top k documents that also match the filter query. * * @param fn * a function that initializes a builder to create the @@ -1303,7 +1400,12 @@ public final KnnSearchResponse knnSearch( // ----- Endpoint: mget /** - * Allows to get multiple documents in one request. + * Get multiple documents. + *

+ * Get multiple JSON documents by ID from one or more indices. If you specify an + * index in the request URI, you only need to specify the document IDs in the + * request body. To ensure fast responses, this multi get (mget) API responds + * with partial results if one or more shards fail. * * @see Documentation @@ -1321,7 +1423,12 @@ public MgetResponse mget(MgetRequest request, Class + * Get multiple JSON documents by ID from one or more indices. If you specify an + * index in the request URI, you only need to specify the document IDs in the + * request body. To ensure fast responses, this multi get (mget) API responds + * with partial results if one or more shards fail. * * @param fn * a function that initializes a builder to create the @@ -1337,7 +1444,12 @@ public final MgetResponse mget(Function + * Get multiple JSON documents by ID from one or more indices. If you specify an + * index in the request URI, you only need to specify the document IDs in the + * request body. To ensure fast responses, this multi get (mget) API responds + * with partial results if one or more shards fail. * * @see Documentation @@ -1355,7 +1467,12 @@ public MgetResponse mget(MgetRequest request, Type tDocum } /** - * Allows to get multiple documents in one request. + * Get multiple documents. + *

+ * Get multiple JSON documents by ID from one or more indices. If you specify an + * index in the request URI, you only need to specify the document IDs in the + * request body. To ensure fast responses, this multi get (mget) API responds + * with partial results if one or more shards fail. * * @param fn * a function that initializes a builder to create the @@ -1525,7 +1642,7 @@ public final MsearchResponse msearch( // ----- Endpoint: msearch_template /** - * Runs multiple templated searches with a single request. + * Run multiple templated searches. * * @see Documentation @@ -1544,7 +1661,7 @@ public MsearchTemplateResponse msearchTemplate(MsearchTem } /** - * Runs multiple templated searches with a single request. + * Run multiple templated searches. * * @param fn * a function that initializes a builder to create the @@ -1561,7 +1678,7 @@ public final MsearchTemplateResponse msearchTemplate( } /** - * Runs multiple templated searches with a single request. + * Run multiple templated searches. * * @see Documentation @@ -1580,7 +1697,7 @@ public MsearchTemplateResponse msearchTemplate(MsearchTem } /** - * Runs multiple templated searches with a single request. + * Run multiple templated searches. * * @param fn * a function that initializes a builder to create the @@ -1599,7 +1716,13 @@ public final MsearchTemplateResponse msearchTemplate( // ----- Endpoint: mtermvectors /** - * Returns multiple termvectors in one request. + * Get multiple term vectors. + *

+ * You can specify existing documents by index and ID or provide artificial + * documents in the body of the request. You can specify the index in the + * request body or request URI. The response contains a docs array + * with all the fetched termvectors. Each element has the structure provided by + * the termvectors API. * * @see Documentation @@ -1614,7 +1737,13 @@ public MtermvectorsResponse mtermvectors(MtermvectorsRequest request) throws IOE } /** - * Returns multiple termvectors in one request. + * Get multiple term vectors. + *

+ * You can specify existing documents by index and ID or provide artificial + * documents in the body of the request. You can specify the index in the + * request body or request URI. The response contains a docs array + * with all the fetched termvectors. Each element has the structure provided by + * the termvectors API. * * @param fn * a function that initializes a builder to create the @@ -1631,7 +1760,13 @@ public final MtermvectorsResponse mtermvectors( } /** - * Returns multiple termvectors in one request. + * Get multiple term vectors. + *

+ * You can specify existing documents by index and ID or provide artificial + * documents in the body of the request. You can specify the index in the + * request body or request URI. The response contains a docs array + * with all the fetched termvectors. Each element has the structure provided by + * the termvectors API. * * @see Documentation @@ -1646,14 +1781,20 @@ public MtermvectorsResponse mtermvectors() throws IOException, ElasticsearchExce // ----- Endpoint: open_point_in_time /** - * A search request by default executes against the most recent visible data of - * the target indices, which is called point in time. Elasticsearch pit (point - * in time) is a lightweight view into the state of the data as it existed when + * Open a point in time. + *

+ * A search request by default runs against the most recent visible data of the + * target indices, which is called point in time. Elasticsearch pit (point in + * time) is a lightweight view into the state of the data as it existed when * initiated. In some cases, it’s preferred to perform multiple search requests * using the same point in time. For example, if refreshes happen between * search_after requests, then the results of those requests might * not be consistent as changes happening between searches are only visible to * the more recent point in time. + *

+ * A point in time must be opened explicitly before being used in search + * requests. The keep_alive parameter tells Elasticsearch how long + * it should persist. * * @see Documentation @@ -1669,14 +1810,20 @@ public OpenPointInTimeResponse openPointInTime(OpenPointInTimeRequest request) } /** - * A search request by default executes against the most recent visible data of - * the target indices, which is called point in time. Elasticsearch pit (point - * in time) is a lightweight view into the state of the data as it existed when + * Open a point in time. + *

+ * A search request by default runs against the most recent visible data of the + * target indices, which is called point in time. Elasticsearch pit (point in + * time) is a lightweight view into the state of the data as it existed when * initiated. In some cases, it’s preferred to perform multiple search requests * using the same point in time. For example, if refreshes happen between * search_after requests, then the results of those requests might * not be consistent as changes happening between searches are only visible to * the more recent point in time. + *

+ * A point in time must be opened explicitly before being used in search + * requests. The keep_alive parameter tells Elasticsearch how long + * it should persist. * * @param fn * a function that initializes a builder to create the @@ -1743,8 +1890,10 @@ public final PutScriptResponse putScript(Function + * Evaluate the quality of ranked search results over a set of typical search + * queries. * * @see Documentation @@ -1759,8 +1908,10 @@ public RankEvalResponse rankEval(RankEvalRequest request) throws IOException, El } /** - * Enables you to evaluate the quality of ranked search results over a set of - * typical search queries. + * Evaluate ranked search results. + *

+ * Evaluate the quality of ranked search results over a set of typical search + * queries. * * @param fn * a function that initializes a builder to create the @@ -1817,7 +1968,9 @@ public final ReindexResponse reindex(Function + * Change the number of requests per second for a particular reindex operation. * * @see Documentation @@ -1833,7 +1986,9 @@ public ReindexRethrottleResponse reindexRethrottle(ReindexRethrottleRequest requ } /** - * Copies documents from a source to a destination. + * Throttle a reindex operation. + *

+ * Change the number of requests per second for a particular reindex operation. * * @param fn * a function that initializes a builder to create the @@ -1852,7 +2007,9 @@ public final ReindexRethrottleResponse reindexRethrottle( // ----- Endpoint: render_search_template /** - * Renders a search template as a search request body. + * Render a search template. + *

+ * Render a search template as a search request body. * * @see Documentation @@ -1868,7 +2025,9 @@ public RenderSearchTemplateResponse renderSearchTemplate(RenderSearchTemplateReq } /** - * Renders a search template as a search request body. + * Render a search template. + *

+ * Render a search template as a search request body. * * @param fn * a function that initializes a builder to create the @@ -1885,7 +2044,9 @@ public final RenderSearchTemplateResponse renderSearchTemplate( } /** - * Renders a search template as a search request body. + * Render a search template. + *

+ * Render a search template as a search request body. * * @see Documentation @@ -2135,9 +2296,11 @@ public final ScrollResponse scroll( // ----- Endpoint: search /** - * Returns search hits that match the query defined in the request. You can - * provide search queries using the q query string parameter or the - * request body. If both are specified, only the query parameter is used. + * Run a search. + *

+ * Get search hits that match the query defined in the request. You can provide + * search queries using the q query string parameter or the request + * body. If both are specified, only the query parameter is used. * * @see Documentation @@ -2155,9 +2318,11 @@ public SearchResponse search(SearchRequest request, Class } /** - * Returns search hits that match the query defined in the request. You can - * provide search queries using the q query string parameter or the - * request body. If both are specified, only the query parameter is used. + * Run a search. + *

+ * Get search hits that match the query defined in the request. You can provide + * search queries using the q query string parameter or the request + * body. If both are specified, only the query parameter is used. * * @param fn * a function that initializes a builder to create the @@ -2174,9 +2339,11 @@ public final SearchResponse search( } /** - * Returns search hits that match the query defined in the request. You can - * provide search queries using the q query string parameter or the - * request body. If both are specified, only the query parameter is used. + * Run a search. + *

+ * Get search hits that match the query defined in the request. You can provide + * search queries using the q query string parameter or the request + * body. If both are specified, only the query parameter is used. * * @see Documentation @@ -2194,9 +2361,11 @@ public SearchResponse search(SearchRequest request, Type } /** - * Returns search hits that match the query defined in the request. You can - * provide search queries using the q query string parameter or the - * request body. If both are specified, only the query parameter is used. + * Run a search. + *

+ * Get search hits that match the query defined in the request. You can provide + * search queries using the q query string parameter or the request + * body. If both are specified, only the query parameter is used. * * @param fn * a function that initializes a builder to create the @@ -2215,7 +2384,9 @@ public final SearchResponse search( // ----- Endpoint: search_mvt /** - * Search a vector tile. Searches a vector tile for geospatial values. + * Search a vector tile. + *

+ * Search a vector tile for geospatial values. * * @see Documentation @@ -2230,7 +2401,9 @@ public BinaryResponse searchMvt(SearchMvtRequest request) throws IOException, El } /** - * Search a vector tile. Searches a vector tile for geospatial values. + * Search a vector tile. + *

+ * Search a vector tile for geospatial values. * * @param fn * a function that initializes a builder to create the @@ -2248,8 +2421,12 @@ public final BinaryResponse searchMvt(Function + * Get the indices and shards that a search request would be run against. This + * information can be useful for working out issues or planning optimizations + * with routing and shard preferences. When filtered aliases are used, the + * filter is returned as part of the indices section. * * @see Documentation @@ -2264,8 +2441,12 @@ public SearchShardsResponse searchShards(SearchShardsRequest request) throws IOE } /** - * Returns information about the indices and shards that a search request would - * be executed against. + * Get the search shards. + *

+ * Get the indices and shards that a search request would be run against. This + * information can be useful for working out issues or planning optimizations + * with routing and shard preferences. When filtered aliases are used, the + * filter is returned as part of the indices section. * * @param fn * a function that initializes a builder to create the @@ -2282,8 +2463,12 @@ public final SearchShardsResponse searchShards( } /** - * Returns information about the indices and shards that a search request would - * be executed against. + * Get the search shards. + *

+ * Get the indices and shards that a search request would be run against. This + * information can be useful for working out issues or planning optimizations + * with routing and shard preferences. When filtered aliases are used, the + * filter is returned as part of the indices section. * * @see Documentation @@ -2298,7 +2483,7 @@ public SearchShardsResponse searchShards() throws IOException, ElasticsearchExce // ----- Endpoint: search_template /** - * Runs a search with a search template. + * Run a search with a search template. * * @see Documentation @@ -2317,7 +2502,7 @@ public SearchTemplateResponse searchTemplate(SearchTempla } /** - * Runs a search with a search template. + * Run a search with a search template. * * @param fn * a function that initializes a builder to create the @@ -2334,7 +2519,7 @@ public final SearchTemplateResponse searchTemplate( } /** - * Runs a search with a search template. + * Run a search with a search template. * * @see Documentation @@ -2353,7 +2538,7 @@ public SearchTemplateResponse searchTemplate(SearchTempla } /** - * Runs a search with a search template. + * Run a search with a search template. * * @param fn * a function that initializes a builder to create the @@ -2431,8 +2616,10 @@ public final TermsEnumResponse termsEnum(Function + * Get information and statistics about terms in the fields of a particular + * document. * * @see Documentation @@ -2448,8 +2635,10 @@ public TermvectorsResponse termvectors(TermvectorsRequest } /** - * Get term vector information. Returns information and statistics about terms - * in the fields of a particular document. + * Get term vector information. + *

+ * Get information and statistics about terms in the fields of a particular + * document. * * @param fn * a function that initializes a builder to create the @@ -2587,8 +2776,12 @@ public final UpdateByQueryResponse updateByQuery( // ----- Endpoint: update_by_query_rethrottle /** - * Changes the number of requests per second for a particular Update By Query - * operation. + * Throttle an update by query operation. + *

+ * Change the number of requests per second for a particular update by query + * operation. Rethrottling that speeds up the query takes effect immediately but + * rethrotting that slows down the query takes effect after completing the + * current batch to prevent scroll timeouts. * * @see Documentation @@ -2604,8 +2797,12 @@ public UpdateByQueryRethrottleResponse updateByQueryRethrottle(UpdateByQueryReth } /** - * Changes the number of requests per second for a particular Update By Query - * operation. + * Throttle an update by query operation. + *

+ * Change the number of requests per second for a particular update by query + * operation. Rethrottling that speeds up the query takes effect immediately but + * rethrotting that slows down the query takes effect after completing the + * current batch to prevent scroll timeouts. * * @param fn * a function that initializes a builder to create the diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/Retriever.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/Retriever.java index 478fdc197..1f2ac2e62 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/Retriever.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/Retriever.java @@ -77,6 +77,8 @@ public enum Kind implements JsonEnum { Rrf("rrf"), + TextSimilarityReranker("text_similarity_reranker"), + ; private final String jsonValue; @@ -173,6 +175,24 @@ public RRFRetriever rrf() { return TaggedUnionUtils.get(this, Kind.Rrf); } + /** + * Is this variant instance of kind {@code text_similarity_reranker}? + */ + public boolean isTextSimilarityReranker() { + return _kind == Kind.TextSimilarityReranker; + } + + /** + * Get the {@code text_similarity_reranker} variant value. + * + * @throws IllegalStateException + * if the current variant is not of the + * {@code text_similarity_reranker} kind. + */ + public TextSimilarityReranker textSimilarityReranker() { + return TaggedUnionUtils.get(this, Kind.TextSimilarityReranker); + } + @Override @SuppressWarnings("unchecked") public void serialize(JsonGenerator generator, JsonpMapper mapper) { @@ -232,6 +252,17 @@ public ObjectBuilder rrf(Function textSimilarityReranker(TextSimilarityReranker v) { + this._kind = Kind.TextSimilarityReranker; + this._value = v; + return this; + } + + public ObjectBuilder textSimilarityReranker( + Function> fn) { + return this.textSimilarityReranker(fn.apply(new TextSimilarityReranker.Builder()).build()); + } + public Retriever build() { _checkSingleUse(); return new Retriever(this); @@ -244,6 +275,7 @@ protected static void setupRetrieverDeserializer(ObjectDeserializer op) op.add(Builder::standard, StandardRetriever._DESERIALIZER, "standard"); op.add(Builder::knn, KnnRetriever._DESERIALIZER, "knn"); op.add(Builder::rrf, RRFRetriever._DESERIALIZER, "rrf"); + op.add(Builder::textSimilarityReranker, TextSimilarityReranker._DESERIALIZER, "text_similarity_reranker"); } diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/RetrieverBase.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/RetrieverBase.java index 6ceefd82f..8b085c951 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/RetrieverBase.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/RetrieverBase.java @@ -31,6 +31,7 @@ import co.elastic.clients.util.ObjectBuilder; import co.elastic.clients.util.WithJsonObjectBuilderBase; import jakarta.json.stream.JsonGenerator; +import java.lang.Float; import java.util.List; import java.util.Objects; import java.util.function.Function; @@ -62,11 +63,15 @@ public abstract class RetrieverBase implements JsonpSerializable { private final List filter; + @Nullable + private final Float minScore; + // --------------------------------------------------------------------------------------------- protected RetrieverBase(AbstractBuilder builder) { this.filter = ApiTypeHelper.unmodifiable(builder.filter); + this.minScore = builder.minScore; } @@ -79,6 +84,17 @@ public final List filter() { return this.filter; } + /** + * Minimum _score for matching documents. Documents with a lower _score are not + * included in the top documents. + *

+ * API name: {@code min_score} + */ + @Nullable + public final Float minScore() { + return this.minScore; + } + /** * Serialize this object to JSON. */ @@ -100,6 +116,11 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) { generator.writeEnd(); } + if (this.minScore != null) { + generator.writeKey("min_score"); + generator.write(this.minScore); + + } } @@ -114,6 +135,9 @@ public abstract static class AbstractBuilder filter; + @Nullable + private Float minScore; + /** * Query to filter the documents that can match. *

@@ -149,6 +173,17 @@ public final BuilderT filter(Function> fn) { return filter(fn.apply(new Query.Builder()).build()); } + /** + * Minimum _score for matching documents. Documents with a lower _score are not + * included in the top documents. + *

+ * API name: {@code min_score} + */ + public final BuilderT minScore(@Nullable Float value) { + this.minScore = value; + return self(); + } + protected abstract BuilderT self(); } @@ -158,6 +193,7 @@ protected static > void setupRetrieve ObjectDeserializer op) { op.add(AbstractBuilder::filter, JsonpDeserializer.arrayDeserializer(Query._DESERIALIZER), "filter"); + op.add(AbstractBuilder::minScore, JsonpDeserializer.floatDeserializer(), "min_score"); } diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/RetrieverBuilders.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/RetrieverBuilders.java index 5a3625e40..839d64cd6 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/RetrieverBuilders.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/RetrieverBuilders.java @@ -96,4 +96,23 @@ public static Retriever rrf(Function> fn) { + Retriever.Builder builder = new Retriever.Builder(); + builder.textSimilarityReranker(fn.apply(new TextSimilarityReranker.Builder()).build()); + return builder.build(); + } + } diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/StandardRetriever.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/StandardRetriever.java index 58dc3347e..cff330e81 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/StandardRetriever.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/StandardRetriever.java @@ -29,7 +29,6 @@ import co.elastic.clients.util.ApiTypeHelper; import co.elastic.clients.util.ObjectBuilder; import jakarta.json.stream.JsonGenerator; -import java.lang.Float; import java.lang.Integer; import java.util.ArrayList; import java.util.List; @@ -71,9 +70,6 @@ public class StandardRetriever extends RetrieverBase implements RetrieverVariant private final List sort; - @Nullable - private final Float minScore; - @Nullable private final FieldCollapse collapse; @@ -86,7 +82,6 @@ private StandardRetriever(Builder builder) { this.searchAfter = ApiTypeHelper.unmodifiable(builder.searchAfter); this.terminateAfter = builder.terminateAfter; this.sort = ApiTypeHelper.unmodifiable(builder.sort); - this.minScore = builder.minScore; this.collapse = builder.collapse; } @@ -141,17 +136,6 @@ public final List sort() { return this.sort; } - /** - * Minimum _score for matching documents. Documents with a lower _score are not - * included in the top documents. - *

- * API name: {@code min_score} - */ - @Nullable - public final Float minScore() { - return this.minScore; - } - /** * Collapses the top documents by a specified key into a single top document per * key. @@ -195,11 +179,6 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) { } generator.writeEnd(); - } - if (this.minScore != null) { - generator.writeKey("min_score"); - generator.write(this.minScore); - } if (this.collapse != null) { generator.writeKey("collapse"); @@ -230,9 +209,6 @@ public static class Builder extends RetrieverBase.AbstractBuilder @Nullable private List sort; - @Nullable - private Float minScore; - @Nullable private FieldCollapse collapse; @@ -403,17 +379,6 @@ public final Builder sort(Function - * API name: {@code min_score} - */ - public final Builder minScore(@Nullable Float value) { - this.minScore = value; - return this; - } - /** * Collapses the top documents by a specified key into a single top document per * key. @@ -467,7 +432,6 @@ protected static void setupStandardRetrieverDeserializer(ObjectDeserializerAPI + * specification + */ +@JsonpDeserializable +public class TextSimilarityReranker extends RetrieverBase implements RetrieverVariant { + private final Retriever retriever; + + @Nullable + private final Integer rankWindowSize; + + @Nullable + private final String inferenceId; + + @Nullable + private final String inferenceText; + + @Nullable + private final String field; + + // --------------------------------------------------------------------------------------------- + + private TextSimilarityReranker(Builder builder) { + super(builder); + + this.retriever = ApiTypeHelper.requireNonNull(builder.retriever, this, "retriever"); + this.rankWindowSize = builder.rankWindowSize; + this.inferenceId = builder.inferenceId; + this.inferenceText = builder.inferenceText; + this.field = builder.field; + + } + + public static TextSimilarityReranker of(Function> fn) { + return fn.apply(new Builder()).build(); + } + + /** + * Retriever variant kind. + */ + @Override + public Retriever.Kind _retrieverKind() { + return Retriever.Kind.TextSimilarityReranker; + } + + /** + * Required - The nested retriever which will produce the first-level results, + * that will later be used for reranking. + *

+ * API name: {@code retriever} + */ + public final Retriever retriever() { + return this.retriever; + } + + /** + * This value determines how many documents we will consider from the nested + * retriever. + *

+ * API name: {@code rank_window_size} + */ + @Nullable + public final Integer rankWindowSize() { + return this.rankWindowSize; + } + + /** + * Unique identifier of the inference endpoint created using the inference API. + *

+ * API name: {@code inference_id} + */ + @Nullable + public final String inferenceId() { + return this.inferenceId; + } + + /** + * The text snippet used as the basis for similarity comparison + *

+ * API name: {@code inference_text} + */ + @Nullable + public final String inferenceText() { + return this.inferenceText; + } + + /** + * The document field to be used for text similarity comparisons. This field + * should contain the text that will be evaluated against the inference_text + *

+ * API name: {@code field} + */ + @Nullable + public final String field() { + return this.field; + } + + protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) { + + super.serializeInternal(generator, mapper); + generator.writeKey("retriever"); + this.retriever.serialize(generator, mapper); + + if (this.rankWindowSize != null) { + generator.writeKey("rank_window_size"); + generator.write(this.rankWindowSize); + + } + if (this.inferenceId != null) { + generator.writeKey("inference_id"); + generator.write(this.inferenceId); + + } + if (this.inferenceText != null) { + generator.writeKey("inference_text"); + generator.write(this.inferenceText); + + } + if (this.field != null) { + generator.writeKey("field"); + generator.write(this.field); + + } + + } + + // --------------------------------------------------------------------------------------------- + + /** + * Builder for {@link TextSimilarityReranker}. + */ + + public static class Builder extends RetrieverBase.AbstractBuilder + implements + ObjectBuilder { + private Retriever retriever; + + @Nullable + private Integer rankWindowSize; + + @Nullable + private String inferenceId; + + @Nullable + private String inferenceText; + + @Nullable + private String field; + + /** + * Required - The nested retriever which will produce the first-level results, + * that will later be used for reranking. + *

+ * API name: {@code retriever} + */ + public final Builder retriever(Retriever value) { + this.retriever = value; + return this; + } + + /** + * Required - The nested retriever which will produce the first-level results, + * that will later be used for reranking. + *

+ * API name: {@code retriever} + */ + public final Builder retriever(Function> fn) { + return this.retriever(fn.apply(new Retriever.Builder()).build()); + } + + /** + * This value determines how many documents we will consider from the nested + * retriever. + *

+ * API name: {@code rank_window_size} + */ + public final Builder rankWindowSize(@Nullable Integer value) { + this.rankWindowSize = value; + return this; + } + + /** + * Unique identifier of the inference endpoint created using the inference API. + *

+ * API name: {@code inference_id} + */ + public final Builder inferenceId(@Nullable String value) { + this.inferenceId = value; + return this; + } + + /** + * The text snippet used as the basis for similarity comparison + *

+ * API name: {@code inference_text} + */ + public final Builder inferenceText(@Nullable String value) { + this.inferenceText = value; + return this; + } + + /** + * The document field to be used for text similarity comparisons. This field + * should contain the text that will be evaluated against the inference_text + *

+ * API name: {@code field} + */ + public final Builder field(@Nullable String value) { + this.field = value; + return this; + } + + @Override + protected Builder self() { + return this; + } + + /** + * Builds a {@link TextSimilarityReranker}. + * + * @throws NullPointerException + * if some of the required fields are null. + */ + public TextSimilarityReranker build() { + _checkSingleUse(); + + return new TextSimilarityReranker(this); + } + } + + // --------------------------------------------------------------------------------------------- + + /** + * Json deserializer for {@link TextSimilarityReranker} + */ + public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer + .lazy(Builder::new, TextSimilarityReranker::setupTextSimilarityRerankerDeserializer); + + protected static void setupTextSimilarityRerankerDeserializer( + ObjectDeserializer op) { + RetrieverBase.setupRetrieverBaseDeserializer(op); + op.add(Builder::retriever, Retriever._DESERIALIZER, "retriever"); + op.add(Builder::rankWindowSize, JsonpDeserializer.integerDeserializer(), "rank_window_size"); + op.add(Builder::inferenceId, JsonpDeserializer.stringDeserializer(), "inference_id"); + op.add(Builder::inferenceText, JsonpDeserializer.stringDeserializer(), "inference_text"); + op.add(Builder::field, JsonpDeserializer.stringDeserializer(), "field"); + + } + +} 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 1ca202ca8..eca1c109a 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,10 +56,12 @@ // typedef: async_search.status.Request /** - * 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 monitoring_user role. + * Get the async search status. + *

+ * Get 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 + * monitoring_user role. * * @see API * specification 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 b6ca9db8f..996d4a6ea 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,13 @@ // typedef: async_search.delete.Request /** - * 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 cancel_task 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 cancel_task cluster privilege. * * @see API * specification 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 dd3acdcb9..79951fd94 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,12 +72,13 @@ public ElasticsearchAsyncSearchAsyncClient withTransportOptions(@Nullable Transp // ----- Endpoint: async_search.delete /** - * 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 cancel_task 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 cancel_task cluster privilege. * * @see Documentation @@ -92,12 +93,13 @@ public CompletableFuture delete(DeleteAsyncSearchRequ } /** - * 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 cancel_task 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 cancel_task cluster privilege. * * @param fn * a function that initializes a builder to create the @@ -115,10 +117,12 @@ public final CompletableFuture delete( // ----- Endpoint: async_search.get /** - * 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. + * 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 Documentation @@ -136,10 +140,12 @@ public CompletableFuture> get(GetA } /** - * 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. + * 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 @@ -156,10 +162,12 @@ public final CompletableFuture> ge } /** - * 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. + * 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 Documentation @@ -177,10 +185,12 @@ public CompletableFuture> get(GetA } /** - * 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. + * 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 @@ -198,10 +208,12 @@ public final CompletableFuture> ge // ----- Endpoint: async_search.status /** - * 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 monitoring_user role. + * Get the async search status. + *

+ * Get 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 + * monitoring_user role. * * @see Documentation @@ -216,10 +228,12 @@ public CompletableFuture status(AsyncSearchStatusRequ } /** - * 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 monitoring_user role. + * Get the async search status. + *

+ * Get 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 + * monitoring_user role. * * @param fn * a function that initializes a builder to create the @@ -237,10 +251,11 @@ public final CompletableFuture status( // ----- Endpoint: async_search.submit /** - * 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. + * 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. *

* Warning: Asynchronous search does not support scroll or search requests that * include only the suggest section. @@ -268,10 +283,11 @@ public CompletableFuture> submit(SubmitReq } /** - * 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. + * 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. *

* Warning: Asynchronous search does not support scroll or search requests that * include only the suggest section. @@ -296,10 +312,11 @@ public final CompletableFuture> submit( } /** - * 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. + * 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. *

* Warning: Asynchronous search does not support scroll or search requests that * include only the suggest section. @@ -326,10 +343,11 @@ public CompletableFuture> submit(SubmitReq } /** - * 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. + * 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. *

* Warning: Asynchronous search does not support scroll or search requests that * include only the suggest section. 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 b156044cd..9594c3d72 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,12 +71,13 @@ public ElasticsearchAsyncSearchClient withTransportOptions(@Nullable TransportOp // ----- Endpoint: async_search.delete /** - * 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 cancel_task 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 cancel_task cluster privilege. * * @see Documentation @@ -92,12 +93,13 @@ public DeleteAsyncSearchResponse delete(DeleteAsyncSearchRequest request) } /** - * 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 cancel_task 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 cancel_task cluster privilege. * * @param fn * a function that initializes a builder to create the @@ -116,10 +118,12 @@ public final DeleteAsyncSearchResponse delete( // ----- Endpoint: async_search.get /** - * 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. + * 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 Documentation @@ -137,10 +141,12 @@ public GetAsyncSearchResponse get(GetAsyncSearchRequest r } /** - * 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. + * 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 @@ -157,10 +163,12 @@ public final GetAsyncSearchResponse get( } /** - * 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. + * 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 Documentation @@ -178,10 +186,12 @@ public GetAsyncSearchResponse get(GetAsyncSearchRequest r } /** - * 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. + * 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 @@ -200,10 +210,12 @@ public final GetAsyncSearchResponse get( // ----- Endpoint: async_search.status /** - * 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 monitoring_user role. + * Get the async search status. + *

+ * Get 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 + * monitoring_user role. * * @see Documentation @@ -219,10 +231,12 @@ public AsyncSearchStatusResponse status(AsyncSearchStatusRequest request) } /** - * 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 monitoring_user role. + * Get the async search status. + *

+ * Get 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 + * monitoring_user role. * * @param fn * a function that initializes a builder to create the @@ -241,10 +255,11 @@ public final AsyncSearchStatusResponse status( // ----- Endpoint: async_search.submit /** - * 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. + * 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. *

* Warning: Asynchronous search does not support scroll or search requests that * include only the suggest section. @@ -272,10 +287,11 @@ public SubmitResponse submit(SubmitRequest request, Class } /** - * 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. + * 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. *

* Warning: Asynchronous search does not support scroll or search requests that * include only the suggest section. @@ -301,10 +317,11 @@ public final SubmitResponse submit( } /** - * 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. + * 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. *

* Warning: Asynchronous search does not support scroll or search requests that * include only the suggest section. @@ -332,10 +349,11 @@ public SubmitResponse submit(SubmitRequest request, Type } /** - * 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. + * 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. *

* Warning: Asynchronous search does not support scroll or search requests that * include only the suggest section. 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 fbd4cbbd5..c4e0cb522 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,12 @@ // typedef: async_search.get.Request /** - * 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. + * 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 API * specification 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 a655d7413..e69c4bc97 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,10 +85,11 @@ // typedef: async_search.submit.Request /** - * 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. + * 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. *

* Warning: Asynchronous search does not support scroll or search requests that * include only the suggest section. diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/autoscaling/AutoscalingPolicy.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/autoscaling/AutoscalingPolicy.java index c9666e558..dabcc0372 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/autoscaling/AutoscalingPolicy.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/autoscaling/AutoscalingPolicy.java @@ -88,7 +88,7 @@ public final List roles() { } /** - * Required - Decider settings + * Required - Decider settings. *

* API name: {@code deciders} */ @@ -191,7 +191,7 @@ public final BuilderT roles(String value, String... values) { } /** - * Required - Decider settings + * Required - Decider settings. *

* API name: {@code deciders} *

@@ -203,7 +203,7 @@ public final BuilderT deciders(Map map) { } /** - * Required - Decider settings + * Required - Decider settings. *

* API name: {@code deciders} *

diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/autoscaling/DeleteAutoscalingPolicyRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/autoscaling/DeleteAutoscalingPolicyRequest.java index b5c9d4b58..4127dc762 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/autoscaling/DeleteAutoscalingPolicyRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/autoscaling/DeleteAutoscalingPolicyRequest.java @@ -56,8 +56,11 @@ // typedef: autoscaling.delete_autoscaling_policy.Request /** - * Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. - * Direct use is not supported. + * Delete an autoscaling policy. + *

+ * NOTE: This feature is designed for indirect use by Elasticsearch Service, + * Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not + * supported. * * @see API 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..0619bc01a 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 @@ -70,8 +70,11 @@ public ElasticsearchAutoscalingAsyncClient withTransportOptions(@Nullable Transp // ----- Endpoint: autoscaling.delete_autoscaling_policy /** - * Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. - * Direct use is not supported. + * Delete an autoscaling policy. + *

+ * NOTE: This feature is designed for indirect use by Elasticsearch Service, + * Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not + * supported. * * @see Documentation @@ -87,8 +90,11 @@ public CompletableFuture deleteAutoscalingPolic } /** - * Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. - * Direct use is not supported. + * Delete an autoscaling policy. + *

+ * NOTE: This feature is designed for indirect use by Elasticsearch Service, + * Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not + * supported. * * @param fn * a function that initializes a builder to create the @@ -106,9 +112,28 @@ public final CompletableFuture deleteAutoscalin // ----- Endpoint: autoscaling.get_autoscaling_capacity /** - * Gets the current autoscaling capacity based on the configured autoscaling - * policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not + * Get the autoscaling capacity. + *

+ * NOTE: This feature is designed for indirect use by Elasticsearch Service, + * Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not * supported. + *

+ * This API gets the current autoscaling capacity based on the configured + * autoscaling policy. It will return information to size the cluster + * appropriately to the current workload. + *

+ * The required_capacity is calculated as the maximum of the + * required_capacity result of all individual deciders that are + * enabled for the policy. + *

+ * The operator should verify that the current_nodes match the + * operator’s knowledge of the cluster to avoid making autoscaling decisions + * based on stale or incomplete information. + *

+ * The response contains decider-specific information you can use to diagnose + * how and why autoscaling determined a certain capacity was required. This + * information is provided for diagnosis only. Do not use this information to + * make autoscaling decisions. * * @see Documentation @@ -122,8 +147,11 @@ public CompletableFuture getAutoscalingCapacity( // ----- Endpoint: autoscaling.get_autoscaling_policy /** - * Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and - * ECK. Direct use is not supported. + * Get an autoscaling policy. + *

+ * NOTE: This feature is designed for indirect use by Elasticsearch Service, + * Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not + * supported. * * @see Documentation @@ -138,8 +166,11 @@ public CompletableFuture getAutoscalingPolicy(GetA } /** - * Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and - * ECK. Direct use is not supported. + * Get an autoscaling policy. + *

+ * NOTE: This feature is designed for indirect use by Elasticsearch Service, + * Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not + * supported. * * @param fn * a function that initializes a builder to create the @@ -157,8 +188,11 @@ public final CompletableFuture getAutoscalingPolic // ----- Endpoint: autoscaling.put_autoscaling_policy /** - * Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and - * ECK. Direct use is not supported. + * Create or update an autoscaling policy. + *

+ * NOTE: This feature is designed for indirect use by Elasticsearch Service, + * Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not + * supported. * * @see Documentation @@ -173,8 +207,11 @@ public CompletableFuture putAutoscalingPolicy(PutA } /** - * Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and - * ECK. Direct use is not supported. + * Create or update an autoscaling policy. + *

+ * NOTE: This feature is designed for indirect use by Elasticsearch Service, + * Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not + * supported. * * @param fn * a function that initializes a builder to create the 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..8b1f6b868 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 @@ -69,8 +69,11 @@ public ElasticsearchAutoscalingClient withTransportOptions(@Nullable TransportOp // ----- Endpoint: autoscaling.delete_autoscaling_policy /** - * Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. - * Direct use is not supported. + * Delete an autoscaling policy. + *

+ * NOTE: This feature is designed for indirect use by Elasticsearch Service, + * Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not + * supported. * * @see Documentation @@ -86,8 +89,11 @@ public DeleteAutoscalingPolicyResponse deleteAutoscalingPolicy(DeleteAutoscaling } /** - * Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. - * Direct use is not supported. + * Delete an autoscaling policy. + *

+ * NOTE: This feature is designed for indirect use by Elasticsearch Service, + * Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not + * supported. * * @param fn * a function that initializes a builder to create the @@ -106,9 +112,28 @@ public final DeleteAutoscalingPolicyResponse deleteAutoscalingPolicy( // ----- Endpoint: autoscaling.get_autoscaling_capacity /** - * Gets the current autoscaling capacity based on the configured autoscaling - * policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not + * Get the autoscaling capacity. + *

+ * NOTE: This feature is designed for indirect use by Elasticsearch Service, + * Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not * supported. + *

+ * This API gets the current autoscaling capacity based on the configured + * autoscaling policy. It will return information to size the cluster + * appropriately to the current workload. + *

+ * The required_capacity is calculated as the maximum of the + * required_capacity result of all individual deciders that are + * enabled for the policy. + *

+ * The operator should verify that the current_nodes match the + * operator’s knowledge of the cluster to avoid making autoscaling decisions + * based on stale or incomplete information. + *

+ * The response contains decider-specific information you can use to diagnose + * how and why autoscaling determined a certain capacity was required. This + * information is provided for diagnosis only. Do not use this information to + * make autoscaling decisions. * * @see Documentation @@ -122,8 +147,11 @@ public GetAutoscalingCapacityResponse getAutoscalingCapacity() throws IOExceptio // ----- Endpoint: autoscaling.get_autoscaling_policy /** - * Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and - * ECK. Direct use is not supported. + * Get an autoscaling policy. + *

+ * NOTE: This feature is designed for indirect use by Elasticsearch Service, + * Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not + * supported. * * @see Documentation @@ -139,8 +167,11 @@ public GetAutoscalingPolicyResponse getAutoscalingPolicy(GetAutoscalingPolicyReq } /** - * Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and - * ECK. Direct use is not supported. + * Get an autoscaling policy. + *

+ * NOTE: This feature is designed for indirect use by Elasticsearch Service, + * Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not + * supported. * * @param fn * a function that initializes a builder to create the @@ -159,8 +190,11 @@ public final GetAutoscalingPolicyResponse getAutoscalingPolicy( // ----- Endpoint: autoscaling.put_autoscaling_policy /** - * Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and - * ECK. Direct use is not supported. + * Create or update an autoscaling policy. + *

+ * NOTE: This feature is designed for indirect use by Elasticsearch Service, + * Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not + * supported. * * @see Documentation @@ -176,8 +210,11 @@ public PutAutoscalingPolicyResponse putAutoscalingPolicy(PutAutoscalingPolicyReq } /** - * Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and - * ECK. Direct use is not supported. + * Create or update an autoscaling policy. + *

+ * NOTE: This feature is designed for indirect use by Elasticsearch Service, + * Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not + * supported. * * @param fn * a function that initializes a builder to create the diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/autoscaling/GetAutoscalingCapacityRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/autoscaling/GetAutoscalingCapacityRequest.java index b96f1c13c..40d0c71a6 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/autoscaling/GetAutoscalingCapacityRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/autoscaling/GetAutoscalingCapacityRequest.java @@ -50,9 +50,28 @@ // typedef: autoscaling.get_autoscaling_capacity.Request /** - * Gets the current autoscaling capacity based on the configured autoscaling - * policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not + * Get the autoscaling capacity. + *

+ * NOTE: This feature is designed for indirect use by Elasticsearch Service, + * Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not * supported. + *

+ * This API gets the current autoscaling capacity based on the configured + * autoscaling policy. It will return information to size the cluster + * appropriately to the current workload. + *

+ * The required_capacity is calculated as the maximum of the + * required_capacity result of all individual deciders that are + * enabled for the policy. + *

+ * The operator should verify that the current_nodes match the + * operator’s knowledge of the cluster to avoid making autoscaling decisions + * based on stale or incomplete information. + *

+ * The response contains decider-specific information you can use to diagnose + * how and why autoscaling determined a certain capacity was required. This + * information is provided for diagnosis only. Do not use this information to + * make autoscaling decisions. * * @see API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/autoscaling/GetAutoscalingPolicyRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/autoscaling/GetAutoscalingPolicyRequest.java index 192c97fc6..ad1047dfc 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/autoscaling/GetAutoscalingPolicyRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/autoscaling/GetAutoscalingPolicyRequest.java @@ -56,8 +56,11 @@ // typedef: autoscaling.get_autoscaling_policy.Request /** - * Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and - * ECK. Direct use is not supported. + * Get an autoscaling policy. + *

+ * NOTE: This feature is designed for indirect use by Elasticsearch Service, + * Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not + * supported. * * @see API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/autoscaling/PutAutoscalingPolicyRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/autoscaling/PutAutoscalingPolicyRequest.java index 7e5ed9a77..e639e46c6 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/autoscaling/PutAutoscalingPolicyRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/autoscaling/PutAutoscalingPolicyRequest.java @@ -59,8 +59,11 @@ // typedef: autoscaling.put_autoscaling_policy.Request /** - * Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and - * ECK. Direct use is not supported. + * Create or update an autoscaling policy. + *

+ * NOTE: This feature is designed for indirect use by Elasticsearch Service, + * Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not + * supported. * * @see API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/ClearScrollRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/ClearScrollRequest.java index 31e9ba08f..b5dde92f7 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/ClearScrollRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/ClearScrollRequest.java @@ -57,7 +57,9 @@ // typedef: _global.clear_scroll.Request /** - * Clears the search context and results for a scrolling search. + * Clear a scrolling search. + *

+ * Clear the search context and results for a scrolling search. * * @see API * specification diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/ClosePointInTimeRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/ClosePointInTimeRequest.java index b867d3d3c..733803252 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/ClosePointInTimeRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/ClosePointInTimeRequest.java @@ -56,7 +56,14 @@ // typedef: _global.close_point_in_time.Request /** - * Closes a point-in-time. + * Close a point in time. + *

+ * A point in time must be opened explicitly before being used in search + * requests. The keep_alive parameter tells Elasticsearch how long + * it should persist. A point in time is automatically closed when the + * keep_alive period has elapsed. However, keeping points in time + * has a cost; close them as soon as they are no longer required for search + * requests. * * @see API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/DeleteByQueryRethrottleRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/DeleteByQueryRethrottleRequest.java index 30291fc23..25a44a666 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/DeleteByQueryRethrottleRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/DeleteByQueryRethrottleRequest.java @@ -56,8 +56,12 @@ // typedef: _global.delete_by_query_rethrottle.Request /** - * Changes the number of requests per second for a particular Delete By Query - * operation. + * Throttle a delete by query operation. + *

+ * Change the number of requests per second for a particular delete by query + * operation. Rethrottling that speeds up the query takes effect immediately but + * rethrotting that slows down the query takes effect after completing the + * current batch to prevent scroll timeouts. * * @see API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/FieldCapsRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/FieldCapsRequest.java index 1bc9ceb3c..49835f35f 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/FieldCapsRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/FieldCapsRequest.java @@ -63,11 +63,14 @@ // typedef: _global.field_caps.Request /** - * The field capabilities API returns the information about the capabilities of - * fields among multiple indices. The field capabilities API returns runtime - * fields like any other field. For example, a runtime field with a type of - * keyword is returned as any other field that belongs to the - * keyword family. + * Get the field capabilities. + *

+ * Get information about the capabilities of fields among multiple indices. + *

+ * For data streams, the API returns field capabilities among the stream’s + * backing indices. It returns runtime fields like any other field. For example, + * a runtime field with a type of keyword is returned the same as any other + * field that belongs to the keyword family. * * @see API * specification diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/KnnSearchRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/KnnSearchRequest.java index 08ef95662..de8f79bee 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/KnnSearchRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/KnnSearchRequest.java @@ -63,11 +63,27 @@ // typedef: _global.knn_search.Request /** - * Performs a kNN search. + * Run a knn search. + *

+ * NOTE: The kNN search API has been replaced by the knn option in + * the search API. + *

+ * Perform a k-nearest neighbor (kNN) search on a dense_vector field and return + * the matching documents. Given a query vector, the API finds the k closest + * vectors and returns those documents as search hits. + *

+ * Elasticsearch uses the HNSW algorithm to support efficient kNN search. Like + * most kNN algorithms, HNSW is an approximate method that sacrifices result + * accuracy for improved search speed. This means the results returned are not + * always the true k closest neighbors. + *

+ * The kNN search API supports restricting the search using a filter. The search + * will return the top k documents that also match the filter query. * * @see API * specification - * @deprecated 8.4.0 + * @deprecated 8.4.0 The kNN search API has been replaced by the + * knn option in the search API. */ @Deprecated @JsonpDeserializable diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/MgetRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/MgetRequest.java index d220b257d..28297fcd9 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/MgetRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/MgetRequest.java @@ -62,7 +62,12 @@ // typedef: _global.mget.Request /** - * Allows to get multiple documents in one request. + * Get multiple documents. + *

+ * Get multiple JSON documents by ID from one or more indices. If you specify an + * index in the request URI, you only need to specify the document IDs in the + * request body. To ensure fast responses, this multi get (mget) API responds + * with partial results if one or more shards fail. * * @see API * specification diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/MsearchTemplateRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/MsearchTemplateRequest.java index 8f023d59d..ca78618da 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/MsearchTemplateRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/MsearchTemplateRequest.java @@ -65,7 +65,7 @@ // typedef: _global.msearch_template.Request /** - * Runs multiple templated searches with a single request. + * Run multiple templated searches. * * @see API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/MtermvectorsRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/MtermvectorsRequest.java index 3c07cebd5..948d2bd0e 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/MtermvectorsRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/MtermvectorsRequest.java @@ -63,7 +63,13 @@ // typedef: _global.mtermvectors.Request /** - * Returns multiple termvectors in one request. + * Get multiple term vectors. + *

+ * You can specify existing documents by index and ID or provide artificial + * documents in the body of the request. You can specify the index in the + * request body or request URI. The response contains a docs array + * with all the fetched termvectors. Each element has the structure provided by + * the termvectors API. * * @see API * specification diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/OpenPointInTimeRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/OpenPointInTimeRequest.java index b0db07d74..1701d0acb 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/OpenPointInTimeRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/OpenPointInTimeRequest.java @@ -63,14 +63,20 @@ // typedef: _global.open_point_in_time.Request /** - * A search request by default executes against the most recent visible data of - * the target indices, which is called point in time. Elasticsearch pit (point - * in time) is a lightweight view into the state of the data as it existed when + * Open a point in time. + *

+ * A search request by default runs against the most recent visible data of the + * target indices, which is called point in time. Elasticsearch pit (point in + * time) is a lightweight view into the state of the data as it existed when * initiated. In some cases, it’s preferred to perform multiple search requests * using the same point in time. For example, if refreshes happen between * search_after requests, then the results of those requests might * not be consistent as changes happening between searches are only visible to * the more recent point in time. + *

+ * A point in time must be opened explicitly before being used in search + * requests. The keep_alive parameter tells Elasticsearch how long + * it should persist. * * @see API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/RankEvalRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/RankEvalRequest.java index d1a40f192..4d9ab42ee 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/RankEvalRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/RankEvalRequest.java @@ -63,8 +63,10 @@ // typedef: _global.rank_eval.Request /** - * Enables you to evaluate the quality of ranked search results over a set of - * typical search queries. + * Evaluate ranked search results. + *

+ * Evaluate the quality of ranked search results over a set of typical search + * queries. * * @see API * specification diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/ReindexRethrottleRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/ReindexRethrottleRequest.java index d8148aa03..24a60f706 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/ReindexRethrottleRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/ReindexRethrottleRequest.java @@ -56,7 +56,9 @@ // typedef: _global.reindex_rethrottle.Request /** - * Copies documents from a source to a destination. + * Throttle a reindex operation. + *

+ * Change the number of requests per second for a particular reindex operation. * * @see API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/RenderSearchTemplateRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/RenderSearchTemplateRequest.java index 702555736..9622a469b 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/RenderSearchTemplateRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/RenderSearchTemplateRequest.java @@ -59,7 +59,9 @@ // typedef: _global.render_search_template.Request /** - * Renders a search template as a search request body. + * Render a search template. + *

+ * Render a search template as a search request body. * * @see API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/SearchMvtRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/SearchMvtRequest.java index e72cf5742..45afb9ef6 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/SearchMvtRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/SearchMvtRequest.java @@ -71,7 +71,9 @@ // typedef: _global.search_mvt.Request /** - * Search a vector tile. Searches a vector tile for geospatial values. + * Search a vector tile. + *

+ * Search a vector tile for geospatial values. * * @see API * specification diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/SearchRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/SearchRequest.java index 4a1b0b677..f03adcb03 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/SearchRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/SearchRequest.java @@ -87,9 +87,11 @@ // typedef: _global.search.Request /** - * Returns search hits that match the query defined in the request. You can - * provide search queries using the q query string parameter or the - * request body. If both are specified, only the query parameter is used. + * Run a search. + *

+ * Get search hits that match the query defined in the request. You can provide + * search queries using the q query string parameter or the request + * body. If both are specified, only the query parameter is used. * * @see API * specification diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/SearchShardsRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/SearchShardsRequest.java index 7e57b903c..066dfb325 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/SearchShardsRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/SearchShardsRequest.java @@ -59,8 +59,12 @@ // typedef: _global.search_shards.Request /** - * Returns information about the indices and shards that a search request would - * be executed against. + * Get the search shards. + *

+ * Get the indices and shards that a search request would be run against. This + * information can be useful for working out issues or planning optimizations + * with routing and shard preferences. When filtered aliases are used, the + * filter is returned as part of the indices section. * * @see API * specification diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/SearchTemplateRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/SearchTemplateRequest.java index 64bc1b3c8..fcf729ccb 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/SearchTemplateRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/SearchTemplateRequest.java @@ -64,7 +64,7 @@ // typedef: _global.search_template.Request /** - * Runs a search with a search template. + * Run a search with a search template. * * @see API * specification diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/TermvectorsRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/TermvectorsRequest.java index a5e09f675..6aa697c67 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/TermvectorsRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/TermvectorsRequest.java @@ -67,8 +67,10 @@ // typedef: _global.termvectors.Request /** - * Get term vector information. Returns information and statistics about terms - * in the fields of a particular document. + * Get term vector information. + *

+ * Get information and statistics about terms in the fields of a particular + * document. * * @see API * specification diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/UpdateByQueryRethrottleRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/UpdateByQueryRethrottleRequest.java index e7a920fe3..b6ee9aba7 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/UpdateByQueryRethrottleRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/UpdateByQueryRethrottleRequest.java @@ -56,8 +56,12 @@ // typedef: _global.update_by_query_rethrottle.Request /** - * Changes the number of requests per second for a particular Update By Query - * operation. + * Throttle an update by query operation. + *

+ * Change the number of requests per second for a particular update by query + * operation. Rethrottling that speeds up the query takes effect immediately but + * rethrotting that slows down the query takes effect after completing the + * current batch to prevent scroll timeouts. * * @see 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 da8ea121d..9b0e37a18 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 @@ -16,9 +16,9 @@ '_global.bulk.UpdateAction': '_global/bulk/types.ts#L169-L205', '_global.bulk.UpdateOperation': '_global/bulk/types.ts#L136-L143', '_global.bulk.WriteOperation': '_global/bulk/types.ts#L109-L128', -'_global.clear_scroll.Request': '_global/clear_scroll/ClearScrollRequest.ts#L23-L46', +'_global.clear_scroll.Request': '_global/clear_scroll/ClearScrollRequest.ts#L23-L48', '_global.clear_scroll.Response': '_global/clear_scroll/ClearScrollResponse.ts#L22-L36', -'_global.close_point_in_time.Request': '_global/close_point_in_time/ClosePointInTimeRequest.ts#L23-L38', +'_global.close_point_in_time.Request': '_global/close_point_in_time/ClosePointInTimeRequest.ts#L23-L43', '_global.close_point_in_time.Response': '_global/close_point_in_time/ClosePointInTimeResponse.ts#L22-L36', '_global.count.Request': '_global/count/CountRequest.ts#L26-L121', '_global.count.Response': '_global/count/CountResponse.ts#L23-L25', @@ -28,7 +28,7 @@ '_global.delete.Response': '_global/delete/DeleteResponse.ts#L22-L34', '_global.delete_by_query.Request': '_global/delete_by_query/DeleteByQueryRequest.ts#L36-L211', '_global.delete_by_query.Response': '_global/delete_by_query/DeleteByQueryResponse.ts#L26-L45', -'_global.delete_by_query_rethrottle.Request': '_global/delete_by_query_rethrottle/DeleteByQueryRethrottleRequest.ts#L24-L42', +'_global.delete_by_query_rethrottle.Request': '_global/delete_by_query_rethrottle/DeleteByQueryRethrottleRequest.ts#L24-L47', '_global.delete_by_query_rethrottle.Response': '_global/delete_by_query_rethrottle/DeleteByQueryRethrottleResponse.ts#L22-L24', '_global.delete_script.Request': '_global/delete_script/DeleteScriptRequest.ts#L24-L53', '_global.delete_script.Response': '_global/delete_script/DeleteScriptResponse.ts#L22-L24', @@ -39,7 +39,7 @@ '_global.explain.Request': '_global/explain/ExplainRequest.ts#L26-L107', '_global.explain.Response': '_global/explain/ExplainResponse.ts#L23-L31', '_global.field_caps.FieldCapability': '_global/field_caps/types.ts#L23-L81', -'_global.field_caps.Request': '_global/field_caps/FieldCapabilitiesRequest.ts#L25-L107', +'_global.field_caps.Request': '_global/field_caps/FieldCapabilitiesRequest.ts#L25-L111', '_global.field_caps.Response': '_global/field_caps/FieldCapabilitiesResponse.ts#L24-L35', '_global.get.GetResult': '_global/get/types.ts#L25-L36', '_global.get.Request': '_global/get/GetRequest.ts#L31-L101', @@ -91,12 +91,12 @@ '_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-L96', '_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', '_global.mget.Operation': '_global/mget/types.ts#L32-L55', -'_global.mget.Request': '_global/mget/MultiGetRequest.ts#L25-L98', +'_global.mget.Request': '_global/mget/MultiGetRequest.ts#L25-L104', '_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#L216-L219', @@ -106,14 +106,14 @@ '_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#L211-L214', -'_global.msearch_template.Request': '_global/msearch_template/MultiSearchTemplateRequest.ts#L25-L71', +'_global.msearch_template.Request': '_global/msearch_template/MultiSearchTemplateRequest.ts#L25-L72', '_global.msearch_template.Response': '_global/msearch_template/MultiSearchTemplateResponse.ts#L22-L24', '_global.msearch_template.TemplateConfig': '_global/msearch_template/types.ts#L28-L54', '_global.mtermvectors.Operation': '_global/mtermvectors/types.ts#L35-L94', -'_global.mtermvectors.Request': '_global/mtermvectors/MultiTermVectorsRequest.ts#L31-L109', +'_global.mtermvectors.Request': '_global/mtermvectors/MultiTermVectorsRequest.ts#L31-L116', '_global.mtermvectors.Response': '_global/mtermvectors/MultiTermVectorsResponse.ts#L22-L24', '_global.mtermvectors.TermVectorsResult': '_global/mtermvectors/types.ts#L96-L104', -'_global.open_point_in_time.Request': '_global/open_point_in_time/OpenPointInTimeRequest.ts#L25-L76', +'_global.open_point_in_time.Request': '_global/open_point_in_time/OpenPointInTimeRequest.ts#L25-L81', '_global.open_point_in_time.Response': '_global/open_point_in_time/OpenPointInTimeResponse.ts#L23-L29', '_global.ping.Request': '_global/ping/PingRequest.ts#L22-L30', '_global.put_script.Request': '_global/put_script/PutScriptRequest.ts#L25-L66', @@ -132,7 +132,7 @@ '_global.rank_eval.RankEvalMetricRecall': '_global/rank_eval/types.ts#L54-L58', '_global.rank_eval.RankEvalQuery': '_global/rank_eval/types.ts#L111-L117', '_global.rank_eval.RankEvalRequestItem': '_global/rank_eval/types.ts#L98-L109', -'_global.rank_eval.Request': '_global/rank_eval/RankEvalRequest.ts#L24-L62', +'_global.rank_eval.Request': '_global/rank_eval/RankEvalRequest.ts#L24-L64', '_global.rank_eval.Response': '_global/rank_eval/RankEvalResponse.ts#L26-L34', '_global.rank_eval.UnratedDocument': '_global/rank_eval/types.ts#L150-L153', '_global.reindex.Destination': '_global/reindex/types.ts#L39-L64', @@ -143,16 +143,16 @@ '_global.reindex_rethrottle.ReindexNode': '_global/reindex_rethrottle/types.ts#L33-L35', '_global.reindex_rethrottle.ReindexStatus': '_global/reindex_rethrottle/types.ts#L37-L85', '_global.reindex_rethrottle.ReindexTask': '_global/reindex_rethrottle/types.ts#L87-L98', -'_global.reindex_rethrottle.Request': '_global/reindex_rethrottle/ReindexRethrottleRequest.ts#L24-L44', +'_global.reindex_rethrottle.Request': '_global/reindex_rethrottle/ReindexRethrottleRequest.ts#L24-L46', '_global.reindex_rethrottle.Response': '_global/reindex_rethrottle/ReindexRethrottleResponse.ts#L23-L25', -'_global.render_search_template.Request': '_global/render_search_template/RenderSearchTemplateRequest.ts#L25-L56', +'_global.render_search_template.Request': '_global/render_search_template/RenderSearchTemplateRequest.ts#L25-L58', '_global.render_search_template.Response': '_global/render_search_template/RenderSearchTemplateResponse.ts#L23-L25', '_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-L75', '_global.scroll.Response': '_global/scroll/ScrollResponse.ts#L22-L24', -'_global.search.Request': '_global/search/SearchRequest.ts#L54-L529', +'_global.search.Request': '_global/search/SearchRequest.ts#L54-L531', '_global.search.Response': '_global/search/SearchResponse.ts#L34-L36', '_global.search.ResponseBody': '_global/search/SearchResponse.ts#L38-L54', '_global.search._types.AggregationBreakdown': '_global/search/_types/profile.ts#L26-L39', @@ -229,21 +229,21 @@ '_global.search._types.TotalHits': '_global/search/_types/hits.ts#L96-L99', '_global.search._types.TotalHitsRelation': '_global/search/_types/hits.ts#L101-L106', '_global.search._types.TrackHits': '_global/search/_types/hits.ts#L144-L152', -'_global.search_mvt.Request': '_global/search_mvt/SearchMvtRequest.ts#L33-L192', +'_global.search_mvt.Request': '_global/search_mvt/SearchMvtRequest.ts#L33-L193', '_global.search_mvt.Response': '_global/search_mvt/SearchMvtResponse.ts#L22-L25', '_global.search_mvt._types.GridAggregationType': '_global/search_mvt/_types/GridType.ts#L30-L33', '_global.search_mvt._types.GridType': '_global/search_mvt/_types/GridType.ts#L20-L28', -'_global.search_shards.Request': '_global/search_shards/SearchShardsRequest.ts#L23-L71', +'_global.search_shards.Request': '_global/search_shards/SearchShardsRequest.ts#L23-L76', '_global.search_shards.Response': '_global/search_shards/SearchShardsResponse.ts#L34-L40', '_global.search_shards.SearchShardsNodeAttributes': '_global/search_shards/SearchShardsResponse.ts#L42-L60', '_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.Request': '_global/search_template/SearchTemplateRequest.ts#L32-L136', '_global.search_template.Response': '_global/search_template/SearchTemplateResponse.ts#L30-L48', '_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', -'_global.termvectors.Request': '_global/termvectors/TermVectorsRequest.ts#L33-L121', +'_global.termvectors.Request': '_global/termvectors/TermVectorsRequest.ts#L33-L122', '_global.termvectors.Response': '_global/termvectors/TermVectorsResponse.ts#L25-L34', '_global.termvectors.Term': '_global/termvectors/types.ts#L34-L40', '_global.termvectors.TermVector': '_global/termvectors/types.ts#L23-L26', @@ -253,7 +253,7 @@ '_global.update.UpdateWriteResponseBase': '_global/update/UpdateResponse.ts#L23-L25', '_global.update_by_query.Request': '_global/update_by_query/UpdateByQueryRequest.ts#L37-L227', '_global.update_by_query.Response': '_global/update_by_query/UpdateByQueryResponse.ts#L26-L45', -'_global.update_by_query_rethrottle.Request': '_global/update_by_query_rethrottle/UpdateByQueryRethrottleRequest.ts#L24-L43', +'_global.update_by_query_rethrottle.Request': '_global/update_by_query_rethrottle/UpdateByQueryRethrottleRequest.ts#L24-L48', '_global.update_by_query_rethrottle.Response': '_global/update_by_query_rethrottle/UpdateByQueryRethrottleResponse.ts#L23-L25', '_global.update_by_query_rethrottle.UpdateByQueryRethrottleNode': '_global/update_by_query_rethrottle/UpdateByQueryRethrottleNode.ts#L25-L27', '_spec_utils.BaseNode': '_spec_utils/BaseNode.ts#L25-L32', @@ -301,8 +301,8 @@ '_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.KnnRetriever': '_types/Retriever.ts#L58-L71', +'_types.KnnQuery': '_types/Knn.ts#L54-L72', +'_types.KnnRetriever': '_types/Retriever.ts#L60-L73', '_types.KnnSearch': '_types/Knn.ts#L30-L52', '_types.LatLonGeoLocation': '_types/Geo.ts#L120-L129', '_types.Level': '_types/common.ts#L250-L254', @@ -317,8 +317,8 @@ '_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.RRFRetriever': '_types/Retriever.ts#L73-L80', +'_types.QueryVectorBuilder': '_types/Knn.ts#L74-L77', +'_types.RRFRetriever': '_types/Retriever.ts#L75-L82', '_types.RankBase': '_types/Rank.ts#L30-L30', '_types.RankContainer': '_types/Rank.ts#L22-L28', '_types.RecoveryStats': '_types/Stats.ts#L228-L233', @@ -329,8 +329,8 @@ '_types.RequestCacheStats': '_types/Stats.ts#L244-L250', '_types.Result': '_types/Result.ts#L20-L26', '_types.Retries': '_types/Retries.ts#L22-L25', -'_types.RetrieverBase': '_types/Retriever.ts#L38-L41', -'_types.RetrieverContainer': '_types/Retriever.ts#L26-L36', +'_types.RetrieverBase': '_types/Retriever.ts#L40-L45', +'_types.RetrieverContainer': '_types/Retriever.ts#L26-L38', '_types.RrfRank': '_types/Rank.ts#L32-L37', '_types.ScoreSort': '_types/sort.ts#L54-L56', '_types.Script': '_types/Scripting.ts#L73-L97', @@ -352,12 +352,13 @@ '_types.SortMode': '_types/sort.ts#L108-L117', '_types.SortOptions': '_types/sort.ts#L86-L96', '_types.SortOrder': '_types/sort.ts#L119-L128', -'_types.StandardRetriever': '_types/Retriever.ts#L43-L56', +'_types.StandardRetriever': '_types/Retriever.ts#L47-L58', '_types.StoreStats': '_types/Stats.ts#L368-L395', '_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.TextSimilarityReranker': '_types/Retriever.ts#L84-L95', '_types.ThreadType': '_types/common.ts#L298-L304', '_types.TimeUnit': '_types/Time.ts#L69-L77', '_types.TopLeftBottomRightGeoBounds': '_types/Geo.ts#L161-L164', @@ -371,261 +372,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 +636,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 +668,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 +713,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 +726,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 +765,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 +863,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,104 +910,104 @@ '_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.Request': 'async_search/delete/AsyncSearchDeleteRequest.ts#L23-L40', 'async_search.delete.Response': 'async_search/delete/AsyncSearchDeleteResponse.ts#L22-L24', -'async_search.get.Request': 'async_search/get/AsyncSearchGetRequest.ts#L24-L56', +'async_search.get.Request': 'async_search/get/AsyncSearchGetRequest.ts#L24-L57', '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.Request': 'async_search/status/AsyncSearchStatusRequest.ts#L23-L39', '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-L289', +'async_search.submit.Request': 'async_search/submit/AsyncSearchSubmitRequest.ts#L55-L290', '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', +'autoscaling._types.AutoscalingPolicy': 'autoscaling/_types/AutoscalingPolicy.ts#L23-L30', +'autoscaling.delete_autoscaling_policy.Request': 'autoscaling/delete_autoscaling_policy/DeleteAutoscalingPolicyRequest.ts#L23-L36', 'autoscaling.delete_autoscaling_policy.Response': 'autoscaling/delete_autoscaling_policy/DeleteAutoscalingPolicyResponse.ts#L22-L24', 'autoscaling.get_autoscaling_capacity.AutoscalingCapacity': 'autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityResponse.ts#L38-L41', 'autoscaling.get_autoscaling_capacity.AutoscalingDecider': 'autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityResponse.ts#L52-L56', 'autoscaling.get_autoscaling_capacity.AutoscalingDeciders': 'autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityResponse.ts#L31-L36', 'autoscaling.get_autoscaling_capacity.AutoscalingNode': 'autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityResponse.ts#L48-L50', 'autoscaling.get_autoscaling_capacity.AutoscalingResources': 'autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityResponse.ts#L43-L46', -'autoscaling.get_autoscaling_capacity.Request': 'autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityRequest.ts#L22-L27', +'autoscaling.get_autoscaling_capacity.Request': 'autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityRequest.ts#L22-L42', 'autoscaling.get_autoscaling_capacity.Response': 'autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityResponse.ts#L25-L29', -'autoscaling.get_autoscaling_policy.Request': 'autoscaling/get_autoscaling_policy/GetAutoscalingPolicyRequest.ts#L23-L32', +'autoscaling.get_autoscaling_policy.Request': 'autoscaling/get_autoscaling_policy/GetAutoscalingPolicyRequest.ts#L23-L36', 'autoscaling.get_autoscaling_policy.Response': 'autoscaling/get_autoscaling_policy/GetAutoscalingPolicyResponse.ts#L22-L24', -'autoscaling.put_autoscaling_policy.Request': 'autoscaling/put_autoscaling_policy/PutAutoscalingPolicyRequest.ts#L24-L35', +'autoscaling.put_autoscaling_policy.Request': 'autoscaling/put_autoscaling_policy/PutAutoscalingPolicyRequest.ts#L24-L39', 'autoscaling.put_autoscaling_policy.Response': 'autoscaling/put_autoscaling_policy/PutAutoscalingPolicyResponse.ts#L22-L24', 'cat._types.CatAnomalyDetectorColumn': 'cat/_types/CatBase.ts#L32-L401', 'cat._types.CatDatafeedColumn': 'cat/_types/CatBase.ts#L405-L471', @@ -1434,9 +1435,9 @@ 'indices._types.IndexSettingsLifecycleStep': 'indices/_types/IndexSettings.ts#L311-L317', 'indices._types.IndexSettingsTimeSeries': 'indices/_types/IndexSettings.ts#L327-L330', 'indices._types.IndexState': 'indices/_types/IndexState.ts#L27-L40', -'indices._types.IndexTemplate': 'indices/_types/IndexTemplate.ts#L28-L67', -'indices._types.IndexTemplateDataStreamConfiguration': 'indices/_types/IndexTemplate.ts#L69-L80', -'indices._types.IndexTemplateSummary': 'indices/_types/IndexTemplate.ts#L82-L104', +'indices._types.IndexTemplate': 'indices/_types/IndexTemplate.ts#L28-L81', +'indices._types.IndexTemplateDataStreamConfiguration': 'indices/_types/IndexTemplate.ts#L83-L94', +'indices._types.IndexTemplateSummary': 'indices/_types/IndexTemplate.ts#L96-L118', 'indices._types.IndexVersioning': 'indices/_types/IndexSettings.ts#L271-L274', 'indices._types.IndexingPressure': 'indices/_types/IndexSettings.ts#L550-L552', 'indices._types.IndexingPressureMemory': 'indices/_types/IndexSettings.ts#L554-L561', @@ -1527,7 +1528,7 @@ 'indices.downsample.Request': 'indices/downsample/Request.ts#L24-L44', 'indices.downsample.Response': 'indices/downsample/Response.ts#L22-L25', 'indices.exists.Request': 'indices/exists/IndicesExistsRequest.ts#L23-L73', -'indices.exists_alias.Request': 'indices/exists_alias/IndicesExistsAliasRequest.ts#L23-L68', +'indices.exists_alias.Request': 'indices/exists_alias/IndicesExistsAliasRequest.ts#L23-L69', 'indices.exists_index_template.Request': 'indices/exists_index_template/IndicesExistsIndexTemplateRequest.ts#L24-L41', 'indices.exists_template.Request': 'indices/exists_template/IndicesExistsTemplateRequest.ts#L24-L39', 'indices.explain_data_lifecycle.DataStreamLifecycleExplain': 'indices/explain_data_lifecycle/IndicesExplainDataLifecycleResponse.ts#L31-L41', @@ -1550,7 +1551,7 @@ 'indices.get.Request': 'indices/get/IndicesGetRequest.ts#L24-L89', 'indices.get.Response': 'indices/get/IndicesGetResponse.ts#L24-L27', 'indices.get_alias.IndexAliases': 'indices/get_alias/IndicesGetAliasResponse.ts#L37-L39', -'indices.get_alias.Request': 'indices/get_alias/IndicesGetAliasRequest.ts#L23-L71', +'indices.get_alias.Request': 'indices/get_alias/IndicesGetAliasRequest.ts#L23-L72', 'indices.get_alias.Response': 'indices/get_alias/IndicesGetAliasResponse.ts#L26-L35', 'indices.get_data_lifecycle.DataStreamWithLifecycle': 'indices/get_data_lifecycle/IndicesGetDataLifecycleResponse.ts#L27-L30', 'indices.get_data_lifecycle.Request': 'indices/get_data_lifecycle/IndicesGetDataLifecycleRequest.ts#L24-L60', @@ -1693,65 +1694,66 @@ '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#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.AppendProcessor': 'ingest/_types/Processors.ts#L328-L343', +'ingest._types.AttachmentProcessor': 'ingest/_types/Processors.ts#L345-L386', +'ingest._types.BytesProcessor': 'ingest/_types/Processors.ts#L555-L571', +'ingest._types.CircleProcessor': 'ingest/_types/Processors.ts#L573-L596', +'ingest._types.CommunityIDProcessor': 'ingest/_types/Processors.ts#L598-L659', +'ingest._types.ConvertProcessor': 'ingest/_types/Processors.ts#L672-L692', +'ingest._types.ConvertType': 'ingest/_types/Processors.ts#L661-L670', +'ingest._types.CsvProcessor': 'ingest/_types/Processors.ts#L694-L727', 'ingest._types.DatabaseConfiguration': 'ingest/_types/Database.ts#L22-L29', -'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.DateIndexNameProcessor': 'ingest/_types/Processors.ts#L729-L767', +'ingest._types.DateProcessor': 'ingest/_types/Processors.ts#L769-L802', +'ingest._types.DissectProcessor': 'ingest/_types/Processors.ts#L804-L823', +'ingest._types.DotExpanderProcessor': 'ingest/_types/Processors.ts#L825-L843', +'ingest._types.DropProcessor': 'ingest/_types/Processors.ts#L845-L845', +'ingest._types.EnrichProcessor': 'ingest/_types/Processors.ts#L847-L886', +'ingest._types.FailProcessor': 'ingest/_types/Processors.ts#L888-L894', +'ingest._types.FingerprintDigest': 'ingest/_types/Processors.ts#L896-L902', +'ingest._types.FingerprintProcessor': 'ingest/_types/Processors.ts#L904-L932', +'ingest._types.ForeachProcessor': 'ingest/_types/Processors.ts#L934-L948', +'ingest._types.GeoGridProcessor': 'ingest/_types/Processors.ts#L388-L429', +'ingest._types.GeoGridTargetFormat': 'ingest/_types/Processors.ts#L437-L440', +'ingest._types.GeoGridTileType': 'ingest/_types/Processors.ts#L431-L435', +'ingest._types.GeoIpProcessor': 'ingest/_types/Processors.ts#L442-L476', +'ingest._types.GrokProcessor': 'ingest/_types/Processors.ts#L950-L981', +'ingest._types.GsubProcessor': 'ingest/_types/Processors.ts#L983-L1007', +'ingest._types.HtmlStripProcessor': 'ingest/_types/Processors.ts#L1009-L1025', +'ingest._types.InferenceConfig': 'ingest/_types/Processors.ts#L1048-L1060', +'ingest._types.InferenceConfigClassification': 'ingest/_types/Processors.ts#L1075-L1101', +'ingest._types.InferenceConfigRegression': 'ingest/_types/Processors.ts#L1062-L1073', +'ingest._types.InferenceProcessor': 'ingest/_types/Processors.ts#L1027-L1046', +'ingest._types.IpLocationProcessor': 'ingest/_types/Processors.ts#L478-L512', +'ingest._types.JoinProcessor': 'ingest/_types/Processors.ts#L1103-L1118', +'ingest._types.JsonProcessor': 'ingest/_types/Processors.ts#L1120-L1149', +'ingest._types.JsonProcessorConflictStrategy': 'ingest/_types/Processors.ts#L1151-L1156', +'ingest._types.KeyValueProcessor': 'ingest/_types/Processors.ts#L1158-L1210', +'ingest._types.LowercaseProcessor': 'ingest/_types/Processors.ts#L1212-L1228', 'ingest._types.Maxmind': 'ingest/_types/Database.ts#L31-L33', -'ingest._types.NetworkDirectionProcessor': 'ingest/_types/Processors.ts#L1190-L1224', +'ingest._types.NetworkDirectionProcessor': 'ingest/_types/Processors.ts#L1230-L1264', 'ingest._types.Pipeline': 'ingest/_types/Pipeline.ts#L23-L51', -'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._types.PipelineProcessor': 'ingest/_types/Processors.ts#L1266-L1277', +'ingest._types.ProcessorBase': 'ingest/_types/Processors.ts#L303-L326', +'ingest._types.ProcessorContainer': 'ingest/_types/Processors.ts#L27-L301', +'ingest._types.RedactProcessor': 'ingest/_types/Processors.ts#L1279-L1320', +'ingest._types.RegisteredDomainProcessor': 'ingest/_types/Processors.ts#L1322-L1338', +'ingest._types.RemoveProcessor': 'ingest/_types/Processors.ts#L1340-L1354', +'ingest._types.RenameProcessor': 'ingest/_types/Processors.ts#L1356-L1372', +'ingest._types.RerouteProcessor': 'ingest/_types/Processors.ts#L1374-L1402', +'ingest._types.ScriptProcessor': 'ingest/_types/Processors.ts#L1404-L1424', +'ingest._types.SetProcessor': 'ingest/_types/Processors.ts#L1426-L1460', +'ingest._types.SetSecurityUserProcessor': 'ingest/_types/Processors.ts#L1462-L1471', +'ingest._types.ShapeType': 'ingest/_types/Processors.ts#L1473-L1476', +'ingest._types.SortProcessor': 'ingest/_types/Processors.ts#L1478-L1494', +'ingest._types.SplitProcessor': 'ingest/_types/Processors.ts#L1496-L1521', +'ingest._types.TerminateProcessor': 'ingest/_types/Processors.ts#L1523-L1523', +'ingest._types.TrimProcessor': 'ingest/_types/Processors.ts#L1525-L1541', +'ingest._types.UppercaseProcessor': 'ingest/_types/Processors.ts#L1543-L1559', +'ingest._types.UriPartsProcessor': 'ingest/_types/Processors.ts#L1579-L1605', +'ingest._types.UrlDecodeProcessor': 'ingest/_types/Processors.ts#L1561-L1577', +'ingest._types.UserAgentProcessor': 'ingest/_types/Processors.ts#L514-L545', +'ingest._types.UserAgentProperty': 'ingest/_types/Processors.ts#L547-L553', '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', @@ -1831,22 +1833,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', @@ -1884,7 +1886,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', @@ -1938,7 +1940,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', @@ -2385,6 +2387,7 @@ 'searchable_snapshots.mount.Response': 'searchable_snapshots/mount/SearchableSnapshotsMountResponse.ts#L22-L26', 'searchable_snapshots.stats.Request': 'searchable_snapshots/stats/SearchableSnapshotsStatsRequest.ts#L24-L35', 'searchable_snapshots.stats.Response': 'searchable_snapshots/stats/SearchableSnapshotsStatsResponse.ts#L22-L27', +'security._types.Access': 'security/_types/Access.ts#L22-L31', 'security._types.ApiKey': 'security/_types/ApiKey.ts#L26-L88', 'security._types.ApplicationGlobalUserPrivileges': 'security/_types/Privileges.ts#L372-L374', 'security._types.ApplicationPrivileges': 'security/_types/Privileges.ts#L27-L40', @@ -2402,6 +2405,7 @@ 'security._types.ManageUserPrivileges': 'security/_types/Privileges.ts#L376-L378', 'security._types.RealmInfo': 'security/_types/RealmInfo.ts#L22-L25', 'security._types.RemoteIndicesPrivileges': 'security/_types/Privileges.ts#L225-L253', +'security._types.ReplicationAccess': 'security/_types/Privileges.ts#L380-L390', 'security._types.RoleDescriptor': 'security/_types/RoleDescriptor.ts#L31-L64', 'security._types.RoleDescriptorRead': 'security/_types/RoleDescriptor.ts#L66-L98', 'security._types.RoleMapping': 'security/_types/RoleMapping.ts#L25-L33', @@ -2410,6 +2414,7 @@ 'security._types.RoleTemplateInlineQuery': 'security/_types/Privileges.ts#L321-L322', 'security._types.RoleTemplateQuery': 'security/_types/Privileges.ts#L289-L299', 'security._types.RoleTemplateScript': 'security/_types/Privileges.ts#L301-L319', +'security._types.SearchAccess': 'security/_types/Privileges.ts#L392-L412', 'security._types.TemplateFormat': 'security/_types/RoleTemplate.ts#L22-L25', 'security._types.User': 'security/_types/User.ts#L23-L31', 'security._types.UserIndicesPrivileges': 'security/_types/Privileges.ts#L255-L277', @@ -2417,144 +2422,148 @@ '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_cross_cluster_api_key.Request': 'security/create_cross_cluster_api_key/CreateCrossClusterApiKeyRequest.ts#L25-L73', +'security.create_cross_cluster_api_key.Response': 'security/create_cross_cluster_api_key/CreateCrossClusterApiKeyResponse.ts#L23-L48', +'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_cross_cluster_api_key.Request': 'security/update_cross_cluster_api_key/UpdateCrossClusterApiKeyRequest.ts#L25-L61', +'security.update_cross_cluster_api_key.Response': 'security/update_cross_cluster_api_key/UpdateCrossClusterApiKeyResponse.ts#L20-L28', +'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', @@ -2862,8 +2871,8 @@ 'watcher.stop.Request': 'watcher/stop/WatcherStopRequest.ts#L22-L26', 'watcher.stop.Response': 'watcher/stop/WatcherStopResponse.ts#L22-L24', 'xpack.info.BuildInformation': 'xpack/info/types.ts#L24-L27', -'xpack.info.Feature': 'xpack/info/types.ts#L84-L89', -'xpack.info.Features': 'xpack/info/types.ts#L42-L82', +'xpack.info.Feature': 'xpack/info/types.ts#L85-L90', +'xpack.info.Features': 'xpack/info/types.ts#L42-L83', 'xpack.info.MinimalLicenseInformation': 'xpack/info/types.ts#L34-L40', 'xpack.info.NativeCodeInformation': 'xpack/info/types.ts#L29-L32', 'xpack.info.Request': 'xpack/info/XPackInfoRequest.ts#L22-L42', @@ -2940,10 +2949,10 @@ if (hash.length > 1) { hash = hash.substring(1); } - window.location = "https://github.com/elastic/elasticsearch-specification/tree/57838c982615f8f05106da3fcd54bad3baf60e73/specification/" + (paths[hash] || ""); + window.location = "https://github.com/elastic/elasticsearch-specification/tree/308b35b489962489e65aad8abab48b2aeaffd275/specification/" + (paths[hash] || ""); - Please see the Elasticsearch API specification. + Please see the Elasticsearch API specification. diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/indices/ExistsAliasRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/indices/ExistsAliasRequest.java index b86cd677b..9a441a4f8 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/indices/ExistsAliasRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/indices/ExistsAliasRequest.java @@ -154,7 +154,10 @@ public final List index() { * only. *

* API name: {@code local} + * + * @deprecated 8.12.0 */ + @Deprecated @Nullable public final Boolean local() { return this.local; @@ -287,7 +290,10 @@ public final Builder index(String value, String... values) { * only. *

* API name: {@code local} + * + * @deprecated 8.12.0 */ + @Deprecated public final Builder local(@Nullable Boolean value) { this.local = value; return this; diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/indices/GetAliasRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/indices/GetAliasRequest.java index 1c2195539..d8d19b1c5 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/indices/GetAliasRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/indices/GetAliasRequest.java @@ -153,7 +153,10 @@ public final List index() { * only. *

* API name: {@code local} + * + * @deprecated 8.12.0 */ + @Deprecated @Nullable public final Boolean local() { return this.local; @@ -286,7 +289,10 @@ public final Builder index(String value, String... values) { * only. *

* API name: {@code local} + * + * @deprecated 8.12.0 */ + @Deprecated public final Builder local(@Nullable Boolean value) { this.local = value; return this; diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/indices/IndexTemplate.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/indices/IndexTemplate.java index 638061f29..ce5ab90a0 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/indices/IndexTemplate.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/indices/IndexTemplate.java @@ -85,6 +85,11 @@ public class IndexTemplate implements JsonpSerializable { @Nullable private final IndexTemplateDataStreamConfiguration dataStream; + @Nullable + private final Boolean deprecated; + + private final List ignoreMissingComponentTemplates; + // --------------------------------------------------------------------------------------------- private IndexTemplate(Builder builder) { @@ -97,6 +102,8 @@ private IndexTemplate(Builder builder) { this.meta = ApiTypeHelper.unmodifiable(builder.meta); this.allowAutoCreate = builder.allowAutoCreate; this.dataStream = builder.dataStream; + this.deprecated = builder.deprecated; + this.ignoreMissingComponentTemplates = ApiTypeHelper.unmodifiable(builder.ignoreMissingComponentTemplates); } @@ -190,6 +197,27 @@ public final IndexTemplateDataStreamConfiguration dataStream() { return this.dataStream; } + /** + * Marks this index template as deprecated. When creating or updating a + * non-deprecated index template that uses deprecated components, Elasticsearch + * will emit a deprecation warning. + *

+ * API name: {@code deprecated} + */ + @Nullable + public final Boolean deprecated() { + return this.deprecated; + } + + /** + * A list of component template names that are allowed to be absent. + *

+ * API name: {@code ignore_missing_component_templates} + */ + public final List ignoreMissingComponentTemplates() { + return this.ignoreMissingComponentTemplates; + } + /** * Serialize this object to JSON. */ @@ -257,6 +285,21 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) { this.dataStream.serialize(generator, mapper); } + if (this.deprecated != null) { + generator.writeKey("deprecated"); + generator.write(this.deprecated); + + } + if (ApiTypeHelper.isDefined(this.ignoreMissingComponentTemplates)) { + generator.writeKey("ignore_missing_component_templates"); + generator.writeStartArray(); + for (String item0 : this.ignoreMissingComponentTemplates) { + generator.write(item0); + + } + generator.writeEnd(); + + } } @@ -294,6 +337,12 @@ public static class Builder extends WithJsonObjectBuilderBase implement @Nullable private IndexTemplateDataStreamConfiguration dataStream; + @Nullable + private Boolean deprecated; + + @Nullable + private List ignoreMissingComponentTemplates; + /** * Required - Name of the index template. *

@@ -450,6 +499,43 @@ public final Builder dataStream( return this.dataStream(fn.apply(new IndexTemplateDataStreamConfiguration.Builder()).build()); } + /** + * Marks this index template as deprecated. When creating or updating a + * non-deprecated index template that uses deprecated components, Elasticsearch + * will emit a deprecation warning. + *

+ * API name: {@code deprecated} + */ + public final Builder deprecated(@Nullable Boolean value) { + this.deprecated = value; + return this; + } + + /** + * A list of component template names that are allowed to be absent. + *

+ * API name: {@code ignore_missing_component_templates} + *

+ * Adds all elements of list to + * ignoreMissingComponentTemplates. + */ + public final Builder ignoreMissingComponentTemplates(List list) { + this.ignoreMissingComponentTemplates = _listAddAll(this.ignoreMissingComponentTemplates, list); + return this; + } + + /** + * A list of component template names that are allowed to be absent. + *

+ * API name: {@code ignore_missing_component_templates} + *

+ * Adds one or more values to ignoreMissingComponentTemplates. + */ + public final Builder ignoreMissingComponentTemplates(String value, String... values) { + this.ignoreMissingComponentTemplates = _listAdd(this.ignoreMissingComponentTemplates, value, values); + return this; + } + @Override protected Builder self() { return this; @@ -488,6 +574,10 @@ protected static void setupIndexTemplateDeserializer(ObjectDeserializerAPI + * specification + */ +@JsonpDeserializable +public class IpLocationProcessor extends ProcessorBase implements ProcessorVariant { + @Nullable + private final String databaseFile; + + private final String field; + + @Nullable + private final Boolean firstOnly; + + @Nullable + private final Boolean ignoreMissing; + + private final List properties; + + @Nullable + private final String targetField; + + @Nullable + private final Boolean downloadDatabaseOnPipelineCreation; + + // --------------------------------------------------------------------------------------------- + + private IpLocationProcessor(Builder builder) { + super(builder); + + this.databaseFile = builder.databaseFile; + this.field = ApiTypeHelper.requireNonNull(builder.field, this, "field"); + this.firstOnly = builder.firstOnly; + this.ignoreMissing = builder.ignoreMissing; + this.properties = ApiTypeHelper.unmodifiable(builder.properties); + this.targetField = builder.targetField; + this.downloadDatabaseOnPipelineCreation = builder.downloadDatabaseOnPipelineCreation; + + } + + public static IpLocationProcessor of(Function> fn) { + return fn.apply(new Builder()).build(); + } + + /** + * Processor variant kind. + */ + @Override + public Processor.Kind _processorKind() { + return Processor.Kind.IpLocation; + } + + /** + * The database filename referring to a database the module ships with + * (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom + * database in the ingest-geoip config directory. + *

+ * API name: {@code database_file} + */ + @Nullable + public final String databaseFile() { + return this.databaseFile; + } + + /** + * Required - The field to get the ip address from for the geographical lookup. + *

+ * API name: {@code field} + */ + public final String field() { + return this.field; + } + + /** + * If true, only the first found IP location data will be returned, + * even if the field contains an array. + *

+ * API name: {@code first_only} + */ + @Nullable + public final Boolean firstOnly() { + return this.firstOnly; + } + + /** + * If true and field does not exist, the processor + * quietly exits without modifying the document. + *

+ * API name: {@code ignore_missing} + */ + @Nullable + public final Boolean ignoreMissing() { + return this.ignoreMissing; + } + + /** + * Controls what properties are added to the target_field based on + * the IP location lookup. + *

+ * API name: {@code properties} + */ + public final List properties() { + return this.properties; + } + + /** + * The field that will hold the geographical information looked up from the + * MaxMind database. + *

+ * API name: {@code target_field} + */ + @Nullable + public final String targetField() { + return this.targetField; + } + + /** + * If true (and if + * ingest.geoip.downloader.eager.download is false), + * the missing database is downloaded when the pipeline is created. Else, the + * download is triggered by when the pipeline is used as the + * default_pipeline or final_pipeline in an index. + *

+ * API name: {@code download_database_on_pipeline_creation} + */ + @Nullable + public final Boolean downloadDatabaseOnPipelineCreation() { + return this.downloadDatabaseOnPipelineCreation; + } + + protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) { + + super.serializeInternal(generator, mapper); + if (this.databaseFile != null) { + generator.writeKey("database_file"); + generator.write(this.databaseFile); + + } + generator.writeKey("field"); + generator.write(this.field); + + if (this.firstOnly != null) { + generator.writeKey("first_only"); + generator.write(this.firstOnly); + + } + if (this.ignoreMissing != null) { + generator.writeKey("ignore_missing"); + generator.write(this.ignoreMissing); + + } + if (ApiTypeHelper.isDefined(this.properties)) { + generator.writeKey("properties"); + generator.writeStartArray(); + for (String item0 : this.properties) { + generator.write(item0); + + } + generator.writeEnd(); + + } + if (this.targetField != null) { + generator.writeKey("target_field"); + generator.write(this.targetField); + + } + if (this.downloadDatabaseOnPipelineCreation != null) { + generator.writeKey("download_database_on_pipeline_creation"); + generator.write(this.downloadDatabaseOnPipelineCreation); + + } + + } + + // --------------------------------------------------------------------------------------------- + + /** + * Builder for {@link IpLocationProcessor}. + */ + + public static class Builder extends ProcessorBase.AbstractBuilder + implements + ObjectBuilder { + @Nullable + private String databaseFile; + + private String field; + + @Nullable + private Boolean firstOnly; + + @Nullable + private Boolean ignoreMissing; + + @Nullable + private List properties; + + @Nullable + private String targetField; + + @Nullable + private Boolean downloadDatabaseOnPipelineCreation; + + /** + * The database filename referring to a database the module ships with + * (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom + * database in the ingest-geoip config directory. + *

+ * API name: {@code database_file} + */ + public final Builder databaseFile(@Nullable String value) { + this.databaseFile = value; + return this; + } + + /** + * Required - The field to get the ip address from for the geographical lookup. + *

+ * API name: {@code field} + */ + public final Builder field(String value) { + this.field = value; + return this; + } + + /** + * If true, only the first found IP location data will be returned, + * even if the field contains an array. + *

+ * API name: {@code first_only} + */ + public final Builder firstOnly(@Nullable Boolean value) { + this.firstOnly = value; + return this; + } + + /** + * If true and field does not exist, the processor + * quietly exits without modifying the document. + *

+ * API name: {@code ignore_missing} + */ + public final Builder ignoreMissing(@Nullable Boolean value) { + this.ignoreMissing = value; + return this; + } + + /** + * Controls what properties are added to the target_field based on + * the IP location lookup. + *

+ * API name: {@code properties} + *

+ * Adds all elements of list to properties. + */ + public final Builder properties(List list) { + this.properties = _listAddAll(this.properties, list); + return this; + } + + /** + * Controls what properties are added to the target_field based on + * the IP location lookup. + *

+ * API name: {@code properties} + *

+ * Adds one or more values to properties. + */ + public final Builder properties(String value, String... values) { + this.properties = _listAdd(this.properties, value, values); + return this; + } + + /** + * The field that will hold the geographical information looked up from the + * MaxMind database. + *

+ * API name: {@code target_field} + */ + public final Builder targetField(@Nullable String value) { + this.targetField = value; + return this; + } + + /** + * If true (and if + * ingest.geoip.downloader.eager.download is false), + * the missing database is downloaded when the pipeline is created. Else, the + * download is triggered by when the pipeline is used as the + * default_pipeline or final_pipeline in an index. + *

+ * API name: {@code download_database_on_pipeline_creation} + */ + public final Builder downloadDatabaseOnPipelineCreation(@Nullable Boolean value) { + this.downloadDatabaseOnPipelineCreation = value; + return this; + } + + @Override + protected Builder self() { + return this; + } + + /** + * Builds a {@link IpLocationProcessor}. + * + * @throws NullPointerException + * if some of the required fields are null. + */ + public IpLocationProcessor build() { + _checkSingleUse(); + + return new IpLocationProcessor(this); + } + } + + // --------------------------------------------------------------------------------------------- + + /** + * Json deserializer for {@link IpLocationProcessor} + */ + public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer + .lazy(Builder::new, IpLocationProcessor::setupIpLocationProcessorDeserializer); + + protected static void setupIpLocationProcessorDeserializer(ObjectDeserializer op) { + ProcessorBase.setupProcessorBaseDeserializer(op); + op.add(Builder::databaseFile, JsonpDeserializer.stringDeserializer(), "database_file"); + op.add(Builder::field, JsonpDeserializer.stringDeserializer(), "field"); + op.add(Builder::firstOnly, JsonpDeserializer.booleanDeserializer(), "first_only"); + op.add(Builder::ignoreMissing, JsonpDeserializer.booleanDeserializer(), "ignore_missing"); + op.add(Builder::properties, JsonpDeserializer.arrayDeserializer(JsonpDeserializer.stringDeserializer()), + "properties"); + op.add(Builder::targetField, JsonpDeserializer.stringDeserializer(), "target_field"); + op.add(Builder::downloadDatabaseOnPipelineCreation, JsonpDeserializer.booleanDeserializer(), + "download_database_on_pipeline_creation"); + + } + +} 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 489acf9e6..721d8f4f3 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 @@ -106,6 +106,8 @@ public enum Kind implements JsonEnum { Foreach("foreach"), + IpLocation("ip_location"), + GeoGrid("geo_grid"), Geoip("geoip"), @@ -485,6 +487,23 @@ public ForeachProcessor foreach() { return TaggedUnionUtils.get(this, Kind.Foreach); } + /** + * Is this variant instance of kind {@code ip_location}? + */ + public boolean isIpLocation() { + return _kind == Kind.IpLocation; + } + + /** + * Get the {@code ip_location} variant value. + * + * @throws IllegalStateException + * if the current variant is not of the {@code ip_location} kind. + */ + public IpLocationProcessor ipLocation() { + return TaggedUnionUtils.get(this, Kind.IpLocation); + } + /** * Is this variant instance of kind {@code geo_grid}? */ @@ -1190,6 +1209,17 @@ public ObjectBuilder foreach( return this.foreach(fn.apply(new ForeachProcessor.Builder()).build()); } + public ObjectBuilder ipLocation(IpLocationProcessor v) { + this._kind = Kind.IpLocation; + this._value = v; + return this; + } + + public ObjectBuilder ipLocation( + Function> fn) { + return this.ipLocation(fn.apply(new IpLocationProcessor.Builder()).build()); + } + public ObjectBuilder geoGrid(GeoGridProcessor v) { this._kind = Kind.GeoGrid; this._value = v; @@ -1525,6 +1555,7 @@ protected static void setupProcessorDeserializer(ObjectDeserializer op) op.add(Builder::fail, FailProcessor._DESERIALIZER, "fail"); op.add(Builder::fingerprint, FingerprintProcessor._DESERIALIZER, "fingerprint"); op.add(Builder::foreach, ForeachProcessor._DESERIALIZER, "foreach"); + op.add(Builder::ipLocation, IpLocationProcessor._DESERIALIZER, "ip_location"); op.add(Builder::geoGrid, GeoGridProcessor._DESERIALIZER, "geo_grid"); op.add(Builder::geoip, GeoIpProcessor._DESERIALIZER, "geoip"); op.add(Builder::grok, GrokProcessor._DESERIALIZER, "grok"); 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 6aa09cbed..ea2e5109b 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 @@ -335,6 +335,24 @@ public static Processor foreach(Function> fn) { + Processor.Builder builder = new Processor.Builder(); + builder.ipLocation(fn.apply(new IpLocationProcessor.Builder()).build()); + return builder.build(); + } + /** * Creates a builder for the {@link GeoGridProcessor geo_grid} {@code Processor} * variant. diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/Access.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/Access.java new file mode 100644 index 000000000..7c6fa84f3 --- /dev/null +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/Access.java @@ -0,0 +1,253 @@ +/* + * 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.security; + +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.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: security._types.Access + +/** + * + * @see API + * specification + */ +@JsonpDeserializable +public class Access implements JsonpSerializable { + private final List replication; + + private final List search; + + // --------------------------------------------------------------------------------------------- + + private Access(Builder builder) { + + this.replication = ApiTypeHelper.unmodifiable(builder.replication); + this.search = ApiTypeHelper.unmodifiable(builder.search); + + } + + public static Access of(Function> fn) { + return fn.apply(new Builder()).build(); + } + + /** + * A list of indices permission entries for cross-cluster replication. + *

+ * API name: {@code replication} + */ + public final List replication() { + return this.replication; + } + + /** + * A list of indices permission entries for cross-cluster search. + *

+ * API name: {@code search} + */ + public final List search() { + return this.search; + } + + /** + * 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.replication)) { + generator.writeKey("replication"); + generator.writeStartArray(); + for (ReplicationAccess item0 : this.replication) { + item0.serialize(generator, mapper); + + } + generator.writeEnd(); + + } + if (ApiTypeHelper.isDefined(this.search)) { + generator.writeKey("search"); + generator.writeStartArray(); + for (SearchAccess item0 : this.search) { + item0.serialize(generator, mapper); + + } + generator.writeEnd(); + + } + + } + + @Override + public String toString() { + return JsonpUtils.toString(this); + } + + // --------------------------------------------------------------------------------------------- + + /** + * Builder for {@link Access}. + */ + + public static class Builder extends WithJsonObjectBuilderBase implements ObjectBuilder { + @Nullable + private List replication; + + @Nullable + private List search; + + /** + * A list of indices permission entries for cross-cluster replication. + *

+ * API name: {@code replication} + *

+ * Adds all elements of list to replication. + */ + public final Builder replication(List list) { + this.replication = _listAddAll(this.replication, list); + return this; + } + + /** + * A list of indices permission entries for cross-cluster replication. + *

+ * API name: {@code replication} + *

+ * Adds one or more values to replication. + */ + public final Builder replication(ReplicationAccess value, ReplicationAccess... values) { + this.replication = _listAdd(this.replication, value, values); + return this; + } + + /** + * A list of indices permission entries for cross-cluster replication. + *

+ * API name: {@code replication} + *

+ * Adds a value to replication using a builder lambda. + */ + public final Builder replication(Function> fn) { + return replication(fn.apply(new ReplicationAccess.Builder()).build()); + } + + /** + * A list of indices permission entries for cross-cluster search. + *

+ * API name: {@code search} + *

+ * Adds all elements of list to search. + */ + public final Builder search(List list) { + this.search = _listAddAll(this.search, list); + return this; + } + + /** + * A list of indices permission entries for cross-cluster search. + *

+ * API name: {@code search} + *

+ * Adds one or more values to search. + */ + public final Builder search(SearchAccess value, SearchAccess... values) { + this.search = _listAdd(this.search, value, values); + return this; + } + + /** + * A list of indices permission entries for cross-cluster search. + *

+ * API name: {@code search} + *

+ * Adds a value to search using a builder lambda. + */ + public final Builder search(Function> fn) { + return search(fn.apply(new SearchAccess.Builder()).build()); + } + + @Override + protected Builder self() { + return this; + } + + /** + * Builds a {@link Access}. + * + * @throws NullPointerException + * if some of the required fields are null. + */ + public Access build() { + _checkSingleUse(); + + return new Access(this); + } + } + + // --------------------------------------------------------------------------------------------- + + /** + * Json deserializer for {@link Access} + */ + public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer.lazy(Builder::new, + Access::setupAccessDeserializer); + + protected static void setupAccessDeserializer(ObjectDeserializer op) { + + op.add(Builder::replication, JsonpDeserializer.arrayDeserializer(ReplicationAccess._DESERIALIZER), + "replication"); + op.add(Builder::search, JsonpDeserializer.arrayDeserializer(SearchAccess._DESERIALIZER), "search"); + + } + +} 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. + *

+ * Create or update a user profile on behalf of another user. * * @see 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. + *

+ * Authenticates a user and returns information about the authenticated user. + * Include the user information in a * basic * auth header. 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. + *

* 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. + *

* 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. + *

+ * Change the passwords of users in the native realm and built-in users. * * @see 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. + *

+ * 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 + * Evict privileges from the native application privilege cache. The cache is + * also automatically cleared for applications that have their privileges + * updated. * * @see 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. + *

+ * Evict users from the user cache. You can completely clear the cache or evict * specific users. * * @see + * Evict roles from the native role cache. * * @see 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. + *

+ * Evict a subset of all entries from the service account token caches. * * @see 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. + *

+ * 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 API * specification diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/CreateCrossClusterApiKeyRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/CreateCrossClusterApiKeyRequest.java new file mode 100644 index 000000000..c702c3b15 --- /dev/null +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/CreateCrossClusterApiKeyRequest.java @@ -0,0 +1,377 @@ +/* + * 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.security; + +import co.elastic.clients.elasticsearch._types.ErrorResponse; +import co.elastic.clients.elasticsearch._types.RequestBase; +import co.elastic.clients.elasticsearch._types.Time; +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.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: security.create_cross_cluster_api_key.Request + +/** + * Create a cross-cluster API key. + *

+ * Create an API key of the cross_cluster type for the API key + * based remote cluster access. A cross_cluster API key cannot be + * used to authenticate through the REST interface. + *

+ * IMPORTANT: To authenticate this request you must use a credential that is not + * an API key. Even if you use an API key that has the required privilege, the + * API returns an error. + *

+ * Cross-cluster API keys are created by the Elasticsearch API key service, + * which is automatically enabled. + *

+ * NOTE: Unlike REST API keys, a cross-cluster API key does not capture + * permissions of the authenticated user. The API key’s effective permission is + * exactly as specified with the access property. + *

+ * 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. + *

+ * By default, API keys never expire. You can specify expiration information + * when you create the API keys. + *

+ * Cross-cluster API keys can only be updated with the update cross-cluster API + * key API. Attempting to update them with the update REST API key API or the + * bulk update REST API keys API will result in an error. + * + * @see API + * specification + */ +@JsonpDeserializable +public class CreateCrossClusterApiKeyRequest extends RequestBase implements JsonpSerializable { + private final Access access; + + @Nullable + private final Time expiration; + + private final Map metadata; + + private final String name; + + // --------------------------------------------------------------------------------------------- + + private CreateCrossClusterApiKeyRequest(Builder builder) { + + this.access = ApiTypeHelper.requireNonNull(builder.access, this, "access"); + this.expiration = builder.expiration; + this.metadata = ApiTypeHelper.unmodifiable(builder.metadata); + this.name = ApiTypeHelper.requireNonNull(builder.name, this, "name"); + + } + + public static CreateCrossClusterApiKeyRequest of( + Function> fn) { + return fn.apply(new Builder()).build(); + } + + /** + * Required - The access to be granted to this API key. The access is composed + * of permissions for cross-cluster search and cross-cluster replication. At + * least one of them must be specified. + *

+ * NOTE: No explicit privileges should be specified for either search or + * replication access. The creation process automatically converts the access + * specification to a role descriptor which has relevant privileges assigned + * accordingly. + *

+ * API name: {@code access} + */ + public final Access access() { + return this.access; + } + + /** + * Expiration time for the API key. By default, API keys never expire. + *

+ * API name: {@code expiration} + */ + @Nullable + public final Time expiration() { + return this.expiration; + } + + /** + * Arbitrary metadata that you want to associate with the API key. It supports + * nested data structure. Within the metadata object, keys beginning with + * _ are reserved for system usage. + *

+ * API name: {@code metadata} + */ + public final Map metadata() { + return this.metadata; + } + + /** + * Required - Specifies the name for this API key. + *

+ * API name: {@code name} + */ + public final String name() { + return this.name; + } + + /** + * 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("access"); + this.access.serialize(generator, mapper); + + if (this.expiration != null) { + generator.writeKey("expiration"); + this.expiration.serialize(generator, mapper); + + } + if (ApiTypeHelper.isDefined(this.metadata)) { + generator.writeKey("metadata"); + generator.writeStartObject(); + for (Map.Entry item0 : this.metadata.entrySet()) { + generator.writeKey(item0.getKey()); + item0.getValue().serialize(generator, mapper); + + } + generator.writeEnd(); + + } + generator.writeKey("name"); + generator.write(this.name); + + } + + // --------------------------------------------------------------------------------------------- + + /** + * Builder for {@link CreateCrossClusterApiKeyRequest}. + */ + + public static class Builder extends RequestBase.AbstractBuilder + implements + ObjectBuilder { + private Access access; + + @Nullable + private Time expiration; + + @Nullable + private Map metadata; + + private String name; + + /** + * Required - The access to be granted to this API key. The access is composed + * of permissions for cross-cluster search and cross-cluster replication. At + * least one of them must be specified. + *

+ * NOTE: No explicit privileges should be specified for either search or + * replication access. The creation process automatically converts the access + * specification to a role descriptor which has relevant privileges assigned + * accordingly. + *

+ * API name: {@code access} + */ + public final Builder access(Access value) { + this.access = value; + return this; + } + + /** + * Required - The access to be granted to this API key. The access is composed + * of permissions for cross-cluster search and cross-cluster replication. At + * least one of them must be specified. + *

+ * NOTE: No explicit privileges should be specified for either search or + * replication access. The creation process automatically converts the access + * specification to a role descriptor which has relevant privileges assigned + * accordingly. + *

+ * API name: {@code access} + */ + public final Builder access(Function> fn) { + return this.access(fn.apply(new Access.Builder()).build()); + } + + /** + * Expiration time for the API key. By default, API keys never expire. + *

+ * API name: {@code expiration} + */ + public final Builder expiration(@Nullable Time value) { + this.expiration = value; + return this; + } + + /** + * Expiration time for the API key. By default, API keys never expire. + *

+ * API name: {@code expiration} + */ + public final Builder expiration(Function> fn) { + return this.expiration(fn.apply(new Time.Builder()).build()); + } + + /** + * Arbitrary metadata that you want to associate with the API key. It supports + * nested data structure. Within the metadata object, keys beginning with + * _ are reserved for system usage. + *

+ * API name: {@code metadata} + *

+ * Adds all entries of map to metadata. + */ + public final Builder metadata(Map map) { + this.metadata = _mapPutAll(this.metadata, map); + return this; + } + + /** + * Arbitrary metadata that you want to associate with the API key. It supports + * nested data structure. Within the metadata object, keys beginning with + * _ are reserved for system usage. + *

+ * API name: {@code metadata} + *

+ * Adds an entry to metadata. + */ + public final Builder metadata(String key, JsonData value) { + this.metadata = _mapPut(this.metadata, key, value); + return this; + } + + /** + * Required - Specifies the name for this API key. + *

+ * API name: {@code name} + */ + public final Builder name(String value) { + this.name = value; + return this; + } + + @Override + protected Builder self() { + return this; + } + + /** + * Builds a {@link CreateCrossClusterApiKeyRequest}. + * + * @throws NullPointerException + * if some of the required fields are null. + */ + public CreateCrossClusterApiKeyRequest build() { + _checkSingleUse(); + + return new CreateCrossClusterApiKeyRequest(this); + } + } + + // --------------------------------------------------------------------------------------------- + + /** + * Json deserializer for {@link CreateCrossClusterApiKeyRequest} + */ + public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer + .lazy(Builder::new, CreateCrossClusterApiKeyRequest::setupCreateCrossClusterApiKeyRequestDeserializer); + + protected static void setupCreateCrossClusterApiKeyRequestDeserializer( + ObjectDeserializer op) { + + op.add(Builder::access, Access._DESERIALIZER, "access"); + op.add(Builder::expiration, Time._DESERIALIZER, "expiration"); + op.add(Builder::metadata, JsonpDeserializer.stringMapDeserializer(JsonData._DESERIALIZER), "metadata"); + op.add(Builder::name, JsonpDeserializer.stringDeserializer(), "name"); + + } + + // --------------------------------------------------------------------------------------------- + + /** + * Endpoint "{@code security.create_cross_cluster_api_key}". + */ + public static final Endpoint _ENDPOINT = new SimpleEndpoint<>( + "es/security.create_cross_cluster_api_key", + + // Request method + request -> { + return "POST"; + + }, + + // Request path + request -> { + return "/_security/cross_cluster/api_key"; + + }, + + // Path parameters + request -> { + return Collections.emptyMap(); + }, + + // Request parameters + request -> { + return Collections.emptyMap(); + + }, SimpleEndpoint.emptyMap(), true, CreateCrossClusterApiKeyResponse._DESERIALIZER); +} diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/CreateCrossClusterApiKeyResponse.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/CreateCrossClusterApiKeyResponse.java new file mode 100644 index 000000000..b3245c4d2 --- /dev/null +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/CreateCrossClusterApiKeyResponse.java @@ -0,0 +1,284 @@ +/* + * 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.security; + +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.Long; +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: security.create_cross_cluster_api_key.Response + +/** + * + * @see API + * specification + */ +@JsonpDeserializable +public class CreateCrossClusterApiKeyResponse implements JsonpSerializable { + private final String apiKey; + + @Nullable + private final Long expiration; + + private final String id; + + private final String name; + + private final String encoded; + + // --------------------------------------------------------------------------------------------- + + private CreateCrossClusterApiKeyResponse(Builder builder) { + + this.apiKey = ApiTypeHelper.requireNonNull(builder.apiKey, this, "apiKey"); + this.expiration = builder.expiration; + this.id = ApiTypeHelper.requireNonNull(builder.id, this, "id"); + this.name = ApiTypeHelper.requireNonNull(builder.name, this, "name"); + this.encoded = ApiTypeHelper.requireNonNull(builder.encoded, this, "encoded"); + + } + + public static CreateCrossClusterApiKeyResponse of( + Function> fn) { + return fn.apply(new Builder()).build(); + } + + /** + * Required - Generated API key. + *

+ * API name: {@code api_key} + */ + public final String apiKey() { + return this.apiKey; + } + + /** + * Expiration in milliseconds for the API key. + *

+ * API name: {@code expiration} + */ + @Nullable + public final Long expiration() { + return this.expiration; + } + + /** + * Required - Unique ID for this API key. + *

+ * API name: {@code id} + */ + public final String id() { + return this.id; + } + + /** + * Required - Specifies the name for this API key. + *

+ * API name: {@code name} + */ + public final String name() { + return this.name; + } + + /** + * Required - API key credentials which is the base64-encoding of the UTF-8 + * representation of id and api_key joined by a colon + * (:). + *

+ * API name: {@code encoded} + */ + public final String encoded() { + return this.encoded; + } + + /** + * 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("api_key"); + generator.write(this.apiKey); + + if (this.expiration != null) { + generator.writeKey("expiration"); + generator.write(this.expiration); + + } + generator.writeKey("id"); + generator.write(this.id); + + generator.writeKey("name"); + generator.write(this.name); + + generator.writeKey("encoded"); + generator.write(this.encoded); + + } + + @Override + public String toString() { + return JsonpUtils.toString(this); + } + + // --------------------------------------------------------------------------------------------- + + /** + * Builder for {@link CreateCrossClusterApiKeyResponse}. + */ + + public static class Builder extends WithJsonObjectBuilderBase + implements + ObjectBuilder { + private String apiKey; + + @Nullable + private Long expiration; + + private String id; + + private String name; + + private String encoded; + + /** + * Required - Generated API key. + *

+ * API name: {@code api_key} + */ + public final Builder apiKey(String value) { + this.apiKey = value; + return this; + } + + /** + * Expiration in milliseconds for the API key. + *

+ * API name: {@code expiration} + */ + public final Builder expiration(@Nullable Long value) { + this.expiration = value; + return this; + } + + /** + * Required - Unique ID for this API key. + *

+ * API name: {@code id} + */ + public final Builder id(String value) { + this.id = value; + return this; + } + + /** + * Required - Specifies the name for this API key. + *

+ * API name: {@code name} + */ + public final Builder name(String value) { + this.name = value; + return this; + } + + /** + * Required - API key credentials which is the base64-encoding of the UTF-8 + * representation of id and api_key joined by a colon + * (:). + *

+ * API name: {@code encoded} + */ + public final Builder encoded(String value) { + this.encoded = value; + return this; + } + + @Override + protected Builder self() { + return this; + } + + /** + * Builds a {@link CreateCrossClusterApiKeyResponse}. + * + * @throws NullPointerException + * if some of the required fields are null. + */ + public CreateCrossClusterApiKeyResponse build() { + _checkSingleUse(); + + return new CreateCrossClusterApiKeyResponse(this); + } + } + + // --------------------------------------------------------------------------------------------- + + /** + * Json deserializer for {@link CreateCrossClusterApiKeyResponse} + */ + public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer + .lazy(Builder::new, CreateCrossClusterApiKeyResponse::setupCreateCrossClusterApiKeyResponseDeserializer); + + protected static void setupCreateCrossClusterApiKeyResponseDeserializer( + ObjectDeserializer op) { + + op.add(Builder::apiKey, JsonpDeserializer.stringDeserializer(), "api_key"); + op.add(Builder::expiration, JsonpDeserializer.longDeserializer(), "expiration"); + op.add(Builder::id, JsonpDeserializer.stringDeserializer(), "id"); + op.add(Builder::name, JsonpDeserializer.stringDeserializer(), "name"); + op.add(Builder::encoded, JsonpDeserializer.stringDeserializer(), "encoded"); + + } + +} 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. + *

+ * Create a service accounts token for access without requiring basic * authentication. * * @see 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 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. + *

+ * Delete roles in the native realm. * * @see API * specification 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. + *

+ * Delete service account tokens for a service in a specified namespace. * * @see 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. + *

+ * Delete users from the native realm. * * @see API * specification 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. + *

+ * Disable user profiles so that they are not visible in user profile searches. * * @see 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. + *

+ * Disable users in the native realm. * * @see API * specification 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..82e2b73e3 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. + *

+ * Create or update a user profile on behalf of another user. * * @see Documentation @@ -86,7 +88,9 @@ public CompletableFuture activateUserProfile(Activa } /** - * Creates or updates a user profile on behalf of another user. + * Activate a user profile. + *

+ * 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 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. + *

+ * Authenticates a user and returns information about the authenticated user. + * Include the user information in a * basic * auth header. 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 authenticate() { // ----- Endpoint: security.bulk_delete_role /** + * Bulk delete roles. + *

* 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 bulkDeleteRole(BulkDeleteRoleRe } /** + * Bulk delete roles. + *

* 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 bulkDeleteRole( // ----- Endpoint: security.bulk_put_role /** + * Bulk create or update roles. + *

* 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 bulkPutRole(BulkPutRoleRequest req } /** + * Bulk create or update roles. + *

* 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 bulkPutRole( // ----- Endpoint: security.change_password /** - * Changes the passwords of users in the native realm and built-in users. + * Change passwords. + *

+ * Change the passwords of users in the native realm and built-in users. * * @see Documentation @@ -214,7 +230,9 @@ public CompletableFuture changePassword(ChangePasswordRe } /** - * Changes the passwords of users in the native realm and built-in users. + * Change passwords. + *

+ * 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 changePassword( } /** - * Changes the passwords of users in the native realm and built-in users. + * Change passwords. + *

+ * Change the passwords of users in the native realm and built-in users. * * @see Documentation @@ -245,7 +265,9 @@ public CompletableFuture 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. + *

+ * 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 clearApiKeyCache(ClearApiKeyC } /** - * Evicts a subset of all entries from the API key cache. The cache is also + * Clear the API key cache. + *

+ * 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 clearApiKeyCache( // ----- Endpoint: security.clear_cached_privileges /** - * Evicts application privileges from the native application privileges cache. + * Clear the privileges cache. + *

+ * Evict privileges from the native application privilege cache. The cache is + * also automatically cleared for applications that have their privileges + * updated. * * @see Documentation @@ -296,7 +324,11 @@ public CompletableFuture clearCachedPrivileges( } /** - * Evicts application privileges from the native application privileges cache. + * Clear the privileges cache. + *

+ * 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 clearCachedPrivile // ----- Endpoint: security.clear_cached_realms /** - * Evicts users from the user cache. Can completely clear the cache or evict + * Clear the user cache. + *

+ * Evict users from the user cache. You can completely clear the cache or evict * specific users. * * @see clearCachedRealms(ClearCache } /** - * Evicts users from the user cache. Can completely clear the cache or evict + * Clear the user cache. + *

+ * 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 clearCachedRealms( // ----- Endpoint: security.clear_cached_roles /** - * Evicts roles from the native role cache. + * Clear the roles cache. + *

+ * Evict roles from the native role cache. * * @see Documentation @@ -364,7 +402,9 @@ public CompletableFuture clearCachedRoles(ClearCachedR } /** - * Evicts roles from the native role cache. + * Clear the roles cache. + *

+ * 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 clearCachedRoles( // ----- Endpoint: security.clear_cached_service_tokens /** - * Evicts tokens from the service account token caches. + * Clear service account token caches. + *

+ * Evict a subset of all entries from the service account token caches. * * @see Documentation @@ -398,7 +440,9 @@ public CompletableFuture clearCachedServiceTok } /** - * Evicts tokens from the service account token caches. + * Clear service account token caches. + *

+ * 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 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. + *

+ * 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 Documentation @@ -436,12 +481,13 @@ public CompletableFuture 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. + *

+ * 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 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. + *

+ * 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 Documentation @@ -474,10 +521,98 @@ public CompletableFuture createApiKey() { CreateApiKeyRequest._ENDPOINT, this.transportOptions); } + // ----- Endpoint: security.create_cross_cluster_api_key + + /** + * Create a cross-cluster API key. + *

+ * Create an API key of the cross_cluster type for the API key + * based remote cluster access. A cross_cluster API key cannot be + * used to authenticate through the REST interface. + *

+ * IMPORTANT: To authenticate this request you must use a credential that is not + * an API key. Even if you use an API key that has the required privilege, the + * API returns an error. + *

+ * Cross-cluster API keys are created by the Elasticsearch API key service, + * which is automatically enabled. + *

+ * NOTE: Unlike REST API keys, a cross-cluster API key does not capture + * permissions of the authenticated user. The API key’s effective permission is + * exactly as specified with the access property. + *

+ * 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. + *

+ * By default, API keys never expire. You can specify expiration information + * when you create the API keys. + *

+ * Cross-cluster API keys can only be updated with the update cross-cluster API + * key API. Attempting to update them with the update REST API key API or the + * bulk update REST API keys API will result in an error. + * + * @see Documentation + * on elastic.co + */ + + public CompletableFuture createCrossClusterApiKey( + CreateCrossClusterApiKeyRequest request) { + @SuppressWarnings("unchecked") + JsonEndpoint endpoint = (JsonEndpoint) CreateCrossClusterApiKeyRequest._ENDPOINT; + + return this.transport.performRequestAsync(request, endpoint, this.transportOptions); + } + + /** + * Create a cross-cluster API key. + *

+ * Create an API key of the cross_cluster type for the API key + * based remote cluster access. A cross_cluster API key cannot be + * used to authenticate through the REST interface. + *

+ * IMPORTANT: To authenticate this request you must use a credential that is not + * an API key. Even if you use an API key that has the required privilege, the + * API returns an error. + *

+ * Cross-cluster API keys are created by the Elasticsearch API key service, + * which is automatically enabled. + *

+ * NOTE: Unlike REST API keys, a cross-cluster API key does not capture + * permissions of the authenticated user. The API key’s effective permission is + * exactly as specified with the access property. + *

+ * 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. + *

+ * By default, API keys never expire. You can specify expiration information + * when you create the API keys. + *

+ * Cross-cluster API keys can only be updated with the update cross-cluster API + * key API. Attempting to update them with the update REST API key API or the + * bulk update REST API keys API will result in an error. + * + * @param fn + * a function that initializes a builder to create the + * {@link CreateCrossClusterApiKeyRequest} + * @see Documentation + * on elastic.co + */ + + public final CompletableFuture createCrossClusterApiKey( + Function> fn) { + return createCrossClusterApiKey(fn.apply(new CreateCrossClusterApiKeyRequest.Builder()).build()); + } + // ----- Endpoint: security.create_service_token /** - * Creates a service accounts token for access without requiring basic + * Create a service account token. + *

+ * Create a service accounts token for access without requiring basic * authentication. * * @see createServiceToken(CreateSe } /** - * Creates a service accounts token for access without requiring basic + * Create a service account token. + *

+ * Create a service accounts token for access without requiring basic * authentication. * * @param fn @@ -512,7 +649,7 @@ public final CompletableFuture createServiceToken( // ----- Endpoint: security.delete_privileges /** - * Removes application privileges. + * Delete application privileges. * * @see Documentation @@ -527,7 +664,7 @@ public CompletableFuture deletePrivileges(DeletePrivil } /** - * Removes application privileges. + * Delete application privileges. * * @param fn * a function that initializes a builder to create the @@ -545,7 +682,9 @@ public final CompletableFuture deletePrivileges( // ----- Endpoint: security.delete_role /** - * Removes roles in the native realm. + * Delete roles. + *

+ * Delete roles in the native realm. * * @see Documentation @@ -560,7 +699,9 @@ public CompletableFuture deleteRole(DeleteRoleRequest reques } /** - * Removes roles in the native realm. + * Delete roles. + *

+ * Delete roles in the native realm. * * @param fn * a function that initializes a builder to create the @@ -578,7 +719,7 @@ public final CompletableFuture deleteRole( // ----- Endpoint: security.delete_role_mapping /** - * Removes role mappings. + * Delete role mappings. * * @see Documentation @@ -593,7 +734,7 @@ public CompletableFuture deleteRoleMapping(DeleteRole } /** - * Removes role mappings. + * Delete role mappings. * * @param fn * a function that initializes a builder to create the @@ -611,7 +752,9 @@ public final CompletableFuture deleteRoleMapping( // ----- Endpoint: security.delete_service_token /** - * Deletes a service account token. + * Delete service account tokens. + *

+ * Delete service account tokens for a service in a specified namespace. * * @see Documentation @@ -626,7 +769,9 @@ public CompletableFuture deleteServiceToken(DeleteSe } /** - * Deletes a service account token. + * Delete service account tokens. + *

+ * Delete service account tokens for a service in a specified namespace. * * @param fn * a function that initializes a builder to create the @@ -644,7 +789,9 @@ public final CompletableFuture deleteServiceToken( // ----- Endpoint: security.delete_user /** - * Deletes users from the native realm. + * Delete users. + *

+ * Delete users from the native realm. * * @see Documentation @@ -659,7 +806,9 @@ public CompletableFuture deleteUser(DeleteUserRequest reques } /** - * Deletes users from the native realm. + * Delete users. + *

+ * Delete users from the native realm. * * @param fn * a function that initializes a builder to create the @@ -677,7 +826,9 @@ public final CompletableFuture deleteUser( // ----- Endpoint: security.disable_user /** - * Disables users in the native realm. + * Disable users. + *

+ * Disable users in the native realm. * * @see Documentation @@ -692,7 +843,9 @@ public CompletableFuture disableUser(DisableUserRequest req } /** - * Disables users in the native realm. + * Disable users. + *

+ * Disable users in the native realm. * * @param fn * a function that initializes a builder to create the @@ -710,7 +863,9 @@ public final CompletableFuture disableUser( // ----- Endpoint: security.disable_user_profile /** - * Disables a user profile so it's not visible in user profile searches. + * Disable a user profile. + *

+ * Disable user profiles so that they are not visible in user profile searches. * * @see Documentation @@ -725,7 +880,9 @@ public CompletableFuture disableUserProfile(DisableU } /** - * Disables a user profile so it's not visible in user profile searches. + * Disable a user profile. + *

+ * 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 +900,9 @@ public final CompletableFuture disableUserProfile( // ----- Endpoint: security.enable_user /** - * Enables users in the native realm. + * Enable users. + *

+ * Enable users in the native realm. * * @see Documentation @@ -758,7 +917,9 @@ public CompletableFuture enableUser(EnableUserRequest reques } /** - * Enables users in the native realm. + * Enable users. + *

+ * Enable users in the native realm. * * @param fn * a function that initializes a builder to create the @@ -776,7 +937,9 @@ public final CompletableFuture enableUser( // ----- Endpoint: security.enable_user_profile /** - * Enables a user profile so it's visible in user profile searches. + * Enable a user profile. + *

+ * Enable user profiles to make them visible in user profile searches. * * @see Documentation @@ -791,7 +954,9 @@ public CompletableFuture enableUserProfile(EnableUser } /** - * Enables a user profile so it's visible in user profile searches. + * Enable a user profile. + *

+ * Enable user profiles to make them visible in user profile searches. * * @param fn * a function that initializes a builder to create the @@ -809,8 +974,10 @@ public final CompletableFuture enableUserProfile( // ----- Endpoint: security.enroll_kibana /** - * Enables a Kibana instance to configure itself for communication with a - * secured Elasticsearch cluster. + * Enroll Kibana. + *

+ * Enable a Kibana instance to configure itself for communication with a secured + * Elasticsearch cluster. * * @see Documentation @@ -824,7 +991,10 @@ public CompletableFuture enrollKibana() { // ----- Endpoint: security.enroll_node /** - * Allows a new node to join an existing cluster with security features enabled. + * Enroll a node. + *

+ * Enroll a new node to allow it to join an existing cluster with security + * features enabled. * * @see Documentation @@ -838,12 +1008,14 @@ public CompletableFuture enrollNode() { // ----- Endpoint: security.get_api_key /** - * Get API key information. Retrieves information for one or more API keys. - * NOTE: If you have only the manage_own_api_key privilege, this - * API returns only the API keys that you own. If you have - * read_security, manage_api_key or greater privileges - * (including manage_security), this API returns all API keys - * regardless of ownership. + * Get API key information. + *

+ * Retrieves information for one or more API keys. NOTE: If you have only the + * manage_own_api_key privilege, this API returns only the API keys + * that you own. If you have read_security, + * manage_api_key or greater privileges (including + * manage_security), this API returns all API keys regardless of + * ownership. * * @see Documentation @@ -858,12 +1030,14 @@ public CompletableFuture getApiKey(GetApiKeyRequest request) } /** - * Get API key information. Retrieves information for one or more API keys. - * NOTE: If you have only the manage_own_api_key privilege, this - * API returns only the API keys that you own. If you have - * read_security, manage_api_key or greater privileges - * (including manage_security), this API returns all API keys - * regardless of ownership. + * Get API key information. + *

+ * Retrieves information for one or more API keys. NOTE: If you have only the + * manage_own_api_key privilege, this API returns only the API keys + * that you own. If you have read_security, + * manage_api_key or greater privileges (including + * manage_security), this API returns all API keys regardless of + * ownership. * * @param fn * a function that initializes a builder to create the @@ -879,12 +1053,14 @@ public final CompletableFuture getApiKey( } /** - * Get API key information. Retrieves information for one or more API keys. - * NOTE: If you have only the manage_own_api_key privilege, this - * API returns only the API keys that you own. If you have - * read_security, manage_api_key or greater privileges - * (including manage_security), this API returns all API keys - * regardless of ownership. + * Get API key information. + *

+ * Retrieves information for one or more API keys. NOTE: If you have only the + * manage_own_api_key privilege, this API returns only the API keys + * that you own. If you have read_security, + * manage_api_key or greater privileges (including + * manage_security), this API returns all API keys regardless of + * ownership. * * @see Documentation @@ -899,8 +1075,10 @@ public CompletableFuture 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. + *

+ * Get the list of cluster privileges and index privileges that are available in + * this version of Elasticsearch. * * @see Documentation @@ -914,7 +1092,7 @@ public CompletableFuture getBuiltinPrivileges() { // ----- Endpoint: security.get_privileges /** - * Retrieves application privileges. + * Get application privileges. * * @see Documentation @@ -929,7 +1107,7 @@ public CompletableFuture getPrivileges(GetPrivilegesReque } /** - * Retrieves application privileges. + * Get application privileges. * * @param fn * a function that initializes a builder to create the @@ -945,7 +1123,7 @@ public final CompletableFuture getPrivileges( } /** - * Retrieves application privileges. + * Get application privileges. * * @see Documentation @@ -960,9 +1138,11 @@ public CompletableFuture 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. + *

+ * 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 Documentation @@ -977,9 +1157,11 @@ public CompletableFuture 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. + *

+ * 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 +1177,11 @@ public final CompletableFuture 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. + *

+ * 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 Documentation @@ -1012,7 +1196,12 @@ public CompletableFuture getRole() { // ----- Endpoint: security.get_role_mapping /** - * Retrieves role mappings. + * Get role mappings. + *

+ * 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 Documentation @@ -1027,7 +1216,12 @@ public CompletableFuture getRoleMapping(GetRoleMappingRe } /** - * Retrieves role mappings. + * Get role mappings. + *

+ * 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 +1237,12 @@ public final CompletableFuture getRoleMapping( } /** - * Retrieves role mappings. + * Get role mappings. + *

+ * 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 Documentation @@ -1058,8 +1257,9 @@ public CompletableFuture getRoleMapping() { // ----- Endpoint: security.get_service_accounts /** - * This API returns a list of service accounts that match the provided path - * parameter(s). + * Get service accounts. + *

+ * Get a list of service accounts that match the provided path parameters. * * @see Documentation @@ -1074,8 +1274,9 @@ public CompletableFuture getServiceAccounts(GetServi } /** - * This API returns a list of service accounts that match the provided path - * parameter(s). + * Get service accounts. + *

+ * 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 +1292,9 @@ public final CompletableFuture getServiceAccounts( } /** - * This API returns a list of service accounts that match the provided path - * parameter(s). + * Get service accounts. + *

+ * Get a list of service accounts that match the provided path parameters. * * @see Documentation @@ -1107,7 +1309,7 @@ public CompletableFuture getServiceAccounts() { // ----- Endpoint: security.get_service_credentials /** - * Retrieves information of all service credentials for a service account. + * Get service account credentials. * * @see Documentation @@ -1123,7 +1325,7 @@ public CompletableFuture 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 +1343,9 @@ public final CompletableFuture getServiceCredenti // ----- Endpoint: security.get_token /** - * Creates a bearer token for access without requiring basic authentication. + * Get a token. + *

+ * Create a bearer token for access without requiring basic authentication. * * @see Documentation @@ -1156,7 +1360,9 @@ public CompletableFuture getToken(GetTokenRequest request) { } /** - * Creates a bearer token for access without requiring basic authentication. + * Get a token. + *

+ * Create a bearer token for access without requiring basic authentication. * * @param fn * a function that initializes a builder to create the @@ -1172,7 +1378,9 @@ public final CompletableFuture getToken( } /** - * Creates a bearer token for access without requiring basic authentication. + * Get a token. + *

+ * Create a bearer token for access without requiring basic authentication. * * @see Documentation @@ -1187,7 +1395,9 @@ public CompletableFuture getToken() { // ----- Endpoint: security.get_user /** - * Retrieves information about users in the native realm and built-in users. + * Get users. + *

+ * Get information about users in the native realm and built-in users. * * @see Documentation @@ -1202,7 +1412,9 @@ public CompletableFuture getUser(GetUserRequest request) { } /** - * Retrieves information about users in the native realm and built-in users. + * Get users. + *

+ * 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 +1430,9 @@ public final CompletableFuture getUser( } /** - * Retrieves information about users in the native realm and built-in users. + * Get users. + *

+ * Get information about users in the native realm and built-in users. * * @see Documentation @@ -1233,7 +1447,7 @@ public CompletableFuture getUser() { // ----- Endpoint: security.get_user_privileges /** - * Retrieves security privileges for the logged in user. + * Get user privileges. * * @see Documentation @@ -1248,7 +1462,7 @@ public CompletableFuture 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 +1478,7 @@ public final CompletableFuture getUserPrivileges( } /** - * Retrieves security privileges for the logged in user. + * Get user privileges. * * @see Documentation @@ -1279,7 +1493,9 @@ public CompletableFuture getUserPrivileges() { // ----- Endpoint: security.get_user_profile /** - * Retrieves a user's profile using the unique profile ID. + * Get a user profile. + *

+ * Get a user's profile using the unique profile ID. * * @see Documentation @@ -1294,7 +1510,9 @@ public CompletableFuture getUserProfile(GetUserProfileRe } /** - * Retrieves a user's profile using the unique profile ID. + * Get a user profile. + *

+ * Get a user's profile using the unique profile ID. * * @param fn * a function that initializes a builder to create the @@ -1312,15 +1530,17 @@ public final CompletableFuture 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. + *

+ * 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. *

* 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 +1566,17 @@ public CompletableFuture 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. + *

+ * 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. *

* 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 +1605,9 @@ public final CompletableFuture grantApiKey( // ----- Endpoint: security.has_privileges /** - * Check user privileges. Determines whether the specified user has a specified - * list of privileges. + * Check user privileges. + *

+ * Determine whether the specified user has a specified list of privileges. * * @see Documentation @@ -1399,8 +1622,9 @@ public CompletableFuture hasPrivileges(HasPrivilegesReque } /** - * Check user privileges. Determines whether the specified user has a specified - * list of privileges. + * Check user privileges. + *

+ * Determine whether the specified user has a specified list of privileges. * * @param fn * a function that initializes a builder to create the @@ -1416,8 +1640,9 @@ public final CompletableFuture hasPrivileges( } /** - * Check user privileges. Determines whether the specified user has a specified - * list of privileges. + * Check user privileges. + *

+ * Determine whether the specified user has a specified list of privileges. * * @see Documentation @@ -1432,8 +1657,10 @@ public CompletableFuture 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. + *

+ * Determine whether the users associated with the specified user profile IDs + * have all the requested privileges. * * @see Documentation @@ -1449,8 +1676,10 @@ public CompletableFuture hasPrivilegesUserProf } /** - * Determines whether the users associated with the specified profile IDs have - * all the requested privileges. + * Check user profile privileges. + *

+ * 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 +1697,13 @@ public final CompletableFuture hasPrivilegesUs // ----- Endpoint: security.invalidate_api_key /** - * Invalidate API keys. Invalidates one or more API keys. The - * manage_api_key privilege allows deleting any API keys. The + * Invalidate API keys. + *

+ * 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 manage_api_key privilege allows deleting any API keys. The * manage_own_api_key only allows deleting API keys that are owned * by the user. In addition, with the manage_own_api_key privilege, * an invalidation request must be issued in one of the three formats: @@ -1477,8 +1711,8 @@ public final CompletableFuture hasPrivilegesUs *

  • Set the parameter owner=true.
    • *
  • Or, set both username and realm_name to match * the user’s identity.
    • - *
  • Or, if the request is issued by an API key, i.e. an API key invalidates - * itself, specify its ID in the ids field.
    • + *
  • Or, if the request is issued by an API key, that is to say an API key + * invalidates itself, specify its ID in the ids field.
    • * * * @see     invalidateApiKey(InvalidateAp } /** - * Invalidate API keys. Invalidates one or more API keys. The - * manage_api_key privilege allows deleting any API keys. The + * Invalidate API keys. + *

    + * 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 manage_api_key privilege allows deleting any API keys. The * manage_own_api_key only allows deleting API keys that are owned * by the user. In addition, with the manage_own_api_key privilege, * an invalidation request must be issued in one of the three formats: @@ -1503,8 +1742,8 @@ public CompletableFuture invalidateApiKey(InvalidateAp *

  • Set the parameter owner=true.
    • *
  • Or, set both username and realm_name to match * the user’s identity.
    • - *
  • Or, if the request is issued by an API key, i.e. an API key invalidates - * itself, specify its ID in the ids field.
    • + *
  • Or, if the request is issued by an API key, that is to say an API key + * invalidates itself, specify its ID in the ids field.
    • * * * @param fn @@ -1521,8 +1760,13 @@ public final CompletableFuture invalidateApiKey( } /** - * Invalidate API keys. Invalidates one or more API keys. The - * manage_api_key privilege allows deleting any API keys. The + * Invalidate API keys. + *

    + * 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 manage_api_key privilege allows deleting any API keys. The * manage_own_api_key only allows deleting API keys that are owned * by the user. In addition, with the manage_own_api_key privilege, * an invalidation request must be issued in one of the three formats: @@ -1530,8 +1774,8 @@ public final CompletableFuture invalidateApiKey( *

  • Set the parameter owner=true.
    • *
  • Or, set both username and realm_name to match * the user’s identity.
    • - *
  • Or, if the request is issued by an API key, i.e. an API key invalidates - * itself, specify its ID in the ids field.
    • + *
  • Or, if the request is issued by an API key, that is to say an API key + * invalidates itself, specify its ID in the ids field.
    • * * * @see     invalidateApiKey() { // ----- Endpoint: security.invalidate_token /** - * Invalidates one or more access tokens or refresh tokens. + * Invalidate a token. + *

    + * 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 + * xpack.security.authc.token.timeout setting. + *

    + * 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 Documentation @@ -1562,7 +1815,16 @@ public CompletableFuture invalidateToken(InvalidateToke } /** - * Invalidates one or more access tokens or refresh tokens. + * Invalidate a token. + *

    + * 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 + * xpack.security.authc.token.timeout setting. + *

    + * 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 +1840,16 @@ public final CompletableFuture invalidateToken( } /** - * Invalidates one or more access tokens or refresh tokens. + * Invalidate a token. + *

    + * 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 + * xpack.security.authc.token.timeout setting. + *

    + * 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 Documentation @@ -1593,7 +1864,7 @@ public CompletableFuture invalidateToken() { // ----- Endpoint: security.put_privileges /** - * Adds or updates application privileges. + * Create or update application privileges. * * @see Documentation @@ -1608,7 +1879,7 @@ public CompletableFuture 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 +1895,7 @@ public final CompletableFuture putPrivileges( } /** - * Adds or updates application privileges. + * Create or update application privileges. * * @see Documentation @@ -1639,9 +1910,12 @@ public CompletableFuture 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. + *

    + * 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 Documentation @@ -1656,9 +1930,12 @@ public CompletableFuture 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. + *

    + * 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 +1953,17 @@ public final CompletableFuture putRole( // ----- Endpoint: security.put_role_mapping /** - * Creates and updates role mappings. + * Create or update role mappings. + *

    + * 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. + *

    + * 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 Documentation @@ -1691,7 +1978,17 @@ public CompletableFuture putRoleMapping(PutRoleMappingRe } /** - * Creates and updates role mappings. + * Create or update role mappings. + *

    + * 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. + *

    + * 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 +2006,11 @@ public final CompletableFuture 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. + *

    + * 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 Documentation @@ -1725,8 +2025,11 @@ public CompletableFuture putUser(PutUserRequest request) { } /** - * Adds and updates users in the native realm. These users are commonly referred - * to as native users. + * Create or update users. + *

    + * 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 +2047,10 @@ public final CompletableFuture 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. + *

    + * Get a paginated list of API keys and their information. You can optionally + * filter the results with a query. * * @see Documentation @@ -1760,8 +2065,10 @@ public CompletableFuture 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. + *

    + * 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 +2084,10 @@ public final CompletableFuture 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. + *

    + * Get a paginated list of API keys and their information. You can optionally + * filter the results with a query. * * @see Documentation @@ -1793,8 +2102,10 @@ public CompletableFuture 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. + *

    + * Get roles in a paginated manner. You can optionally filter the results with a + * query. * * @see Documentation @@ -1809,8 +2120,10 @@ public CompletableFuture queryRole(QueryRoleRequest request) } /** - * Retrieves roles in a paginated manner. You can optionally filter the results - * with a query. + * Find roles with a query. + *

    + * 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 +2139,10 @@ public final CompletableFuture queryRole( } /** - * Retrieves roles in a paginated manner. You can optionally filter the results - * with a query. + * Find roles with a query. + *

    + * Get roles in a paginated manner. You can optionally filter the results with a + * query. * * @see Documentation @@ -1842,8 +2157,10 @@ public CompletableFuture 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. + *

    + * Get information for users in a paginated manner. You can optionally filter + * the results with a query. * * @see Documentation @@ -1858,8 +2175,10 @@ public CompletableFuture 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. + *

    + * 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 +2194,10 @@ public final CompletableFuture queryUser( } /** - * Retrieves information for Users in a paginated manner. You can optionally - * filter the results with a query. + * Find users with a query. + *

    + * Get information for users in a paginated manner. You can optionally filter + * the results with a query. * * @see Documentation @@ -1891,7 +2212,9 @@ public CompletableFuture queryUser() { // ----- Endpoint: security.saml_authenticate /** - * Submits a SAML Response message to Elasticsearch for consumption. + * Authenticate SAML. + *

    + * Submits a SAML response message to Elasticsearch for consumption. * * @see Documentation @@ -1906,7 +2229,9 @@ public CompletableFuture samlAuthenticate(SamlAuthenti } /** - * Submits a SAML Response message to Elasticsearch for consumption. + * Authenticate SAML. + *

    + * Submits a SAML response message to Elasticsearch for consumption. * * @param fn * a function that initializes a builder to create the @@ -1924,6 +2249,8 @@ public final CompletableFuture samlAuthenticate( // ----- Endpoint: security.saml_complete_logout /** + * Logout of SAML completely. + *

    * Verifies the logout response sent from the SAML IdP. * * @see samlCompleteLogout(SamlCompleteLogoutR } /** + * Logout of SAML completely. + *

    * Verifies the logout response sent from the SAML IdP. * * @param fn @@ -1957,6 +2286,8 @@ public final CompletableFuture samlCompleteLogout( // ----- Endpoint: security.saml_invalidate /** + * Invalidate SAML. + *

    * Submits a SAML LogoutRequest message to Elasticsearch for consumption. * * @see samlInvalidate(SamlInvalidateRe } /** + * Invalidate SAML. + *

    * Submits a SAML LogoutRequest message to Elasticsearch for consumption. * * @param fn @@ -1990,6 +2323,8 @@ public final CompletableFuture samlInvalidate( // ----- Endpoint: security.saml_logout /** + * Logout of SAML. + *

    * Submits a request to invalidate an access token and refresh token. * * @see samlLogout(SamlLogoutRequest reques } /** + * Logout of SAML. + *

    * Submits a request to invalidate an access token and refresh token. * * @param fn @@ -2023,8 +2360,11 @@ public final CompletableFuture 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. + *

    + * Creates a SAML authentication request (<AuthnRequest>) as + * a URL string, based on the configuration of the respective SAML realm in + * Elasticsearch. * * @see Documentation @@ -2040,8 +2380,11 @@ public CompletableFuture 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. + *

    + * Creates a SAML authentication request (<AuthnRequest>) 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 +2400,11 @@ public final CompletableFuture 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. + *

    + * Creates a SAML authentication request (<AuthnRequest>) as + * a URL string, based on the configuration of the respective SAML realm in + * Elasticsearch. * * @see Documentation @@ -2073,6 +2419,8 @@ public CompletableFuture samlPrepareAuthentic // ----- Endpoint: security.saml_service_provider_metadata /** + * Create SAML service provider metadata. + *

    * Generate SAML metadata for a SAML 2.0 Service Provider. * * @see samlServiceProvide } /** + * Create SAML service provider metadata. + *

    * Generate SAML metadata for a SAML 2.0 Service Provider. * * @param fn @@ -2107,6 +2457,8 @@ public final CompletableFuture samlServiceP // ----- Endpoint: security.suggest_user_profiles /** + * Suggest a user profile. + *

    * Get suggestions for user profiles that match specified search criteria. * * @see suggestUserProfiles(Sugges } /** + * Suggest a user profile. + *

    * Get suggestions for user profiles that match specified search criteria. * * @param fn @@ -2138,6 +2492,8 @@ public final CompletableFuture suggestUserProfiles( } /** + * Suggest a user profile. + *

    * Get suggestions for user profiles that match specified search criteria. * * @see 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 role_descriptors 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 role_descriptors 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 run_as 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. + *

    + * 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 role_descriptors 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 role_descriptors 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 + * run_as 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 +2543,24 @@ public CompletableFuture 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 role_descriptors 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 role_descriptors 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 run_as 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. + *

    + * 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 role_descriptors 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 role_descriptors 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 + * run_as 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. * @@ -2217,11 +2577,53 @@ public final CompletableFuture updateApiKey( return updateApiKey(fn.apply(new UpdateApiKeyRequest.Builder()).build()); } + // ----- Endpoint: security.update_cross_cluster_api_key + + /** + * Update a cross-cluster API key. + *

    + * Update the attributes of an existing cross-cluster API key, which is used for + * API key based remote cluster access. + * + * @see Documentation + * on elastic.co + */ + + public CompletableFuture updateCrossClusterApiKey( + UpdateCrossClusterApiKeyRequest request) { + @SuppressWarnings("unchecked") + JsonEndpoint endpoint = (JsonEndpoint) UpdateCrossClusterApiKeyRequest._ENDPOINT; + + return this.transport.performRequestAsync(request, endpoint, this.transportOptions); + } + + /** + * Update a cross-cluster API key. + *

    + * Update the attributes of an existing cross-cluster API key, which is used for + * API key based remote cluster access. + * + * @param fn + * a function that initializes a builder to create the + * {@link UpdateCrossClusterApiKeyRequest} + * @see Documentation + * on elastic.co + */ + + public final CompletableFuture updateCrossClusterApiKey( + Function> fn) { + return updateCrossClusterApiKey(fn.apply(new UpdateCrossClusterApiKeyRequest.Builder()).build()); + } + // ----- 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. + *

    + * Update specific data for the user profile that is associated with a unique + * ID. * * @see Documentation @@ -2237,8 +2639,10 @@ public CompletableFuture updateUserProfileData( } /** - * Updates specific data for the user profile that's associated with the - * specified unique ID. + * Update user profile data. + *

    + * 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..ae97689ae 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. + *

    + * Create or update a user profile on behalf of another user. * * @see Documentation @@ -85,7 +87,9 @@ public ActivateUserProfileResponse activateUserProfile(ActivateUserProfileReques } /** - * Creates or updates a user profile on behalf of another user. + * Activate a user profile. + *

    + * 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. + *

    + * Authenticates a user and returns information about the authenticated user. + * Include the user information in a * basic * auth header. 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. + *

    * 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. + *

    * 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. + *

    * 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. + *

    * 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. + *

    + * Change the passwords of users in the native realm and built-in users. * * @see 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. + *

    + * 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. + *

    + * Change the passwords of users in the native realm and built-in users. * * @see 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. + *

    + * 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 + * 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. + *

    + * Evict privileges from the native application privilege cache. The cache is + * also automatically cleared for applications that have their privileges + * updated. * * @see Documentation @@ -303,7 +331,11 @@ public ClearCachedPrivilegesResponse clearCachedPrivileges(ClearCachedPrivileges } /** - * Evicts application privileges from the native application privileges cache. + * Clear the privileges cache. + *

    + * 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. + *

    + * Evict users from the user cache. You can completely clear the cache or evict * specific users. * * @see + * 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. + *

    + * Evict roles from the native role cache. * * @see Documentation @@ -375,7 +413,9 @@ public ClearCachedRolesResponse clearCachedRoles(ClearCachedRolesRequest request } /** - * Evicts roles from the native role cache. + * Clear the roles cache. + *

    + * 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. + *

    + * Evict a subset of all entries from the service account token caches. * * @see Documentation @@ -410,7 +452,9 @@ public ClearCachedServiceTokensResponse clearCachedServiceTokens(ClearCachedServ } /** - * Evicts tokens from the service account token caches. + * Clear service account token caches. + *

    + * 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. + *

    + * 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 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. + *

    + * 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. + *

    + * 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 Documentation @@ -488,10 +535,99 @@ public CreateApiKeyResponse createApiKey() throws IOException, ElasticsearchExce this.transportOptions); } + // ----- Endpoint: security.create_cross_cluster_api_key + + /** + * Create a cross-cluster API key. + *

    + * Create an API key of the cross_cluster type for the API key + * based remote cluster access. A cross_cluster API key cannot be + * used to authenticate through the REST interface. + *

    + * IMPORTANT: To authenticate this request you must use a credential that is not + * an API key. Even if you use an API key that has the required privilege, the + * API returns an error. + *

    + * Cross-cluster API keys are created by the Elasticsearch API key service, + * which is automatically enabled. + *

    + * NOTE: Unlike REST API keys, a cross-cluster API key does not capture + * permissions of the authenticated user. The API key’s effective permission is + * exactly as specified with the access property. + *

    + * 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. + *

    + * By default, API keys never expire. You can specify expiration information + * when you create the API keys. + *

    + * Cross-cluster API keys can only be updated with the update cross-cluster API + * key API. Attempting to update them with the update REST API key API or the + * bulk update REST API keys API will result in an error. + * + * @see Documentation + * on elastic.co + */ + + public CreateCrossClusterApiKeyResponse createCrossClusterApiKey(CreateCrossClusterApiKeyRequest request) + throws IOException, ElasticsearchException { + @SuppressWarnings("unchecked") + JsonEndpoint endpoint = (JsonEndpoint) CreateCrossClusterApiKeyRequest._ENDPOINT; + + return this.transport.performRequest(request, endpoint, this.transportOptions); + } + + /** + * Create a cross-cluster API key. + *

    + * Create an API key of the cross_cluster type for the API key + * based remote cluster access. A cross_cluster API key cannot be + * used to authenticate through the REST interface. + *

    + * IMPORTANT: To authenticate this request you must use a credential that is not + * an API key. Even if you use an API key that has the required privilege, the + * API returns an error. + *

    + * Cross-cluster API keys are created by the Elasticsearch API key service, + * which is automatically enabled. + *

    + * NOTE: Unlike REST API keys, a cross-cluster API key does not capture + * permissions of the authenticated user. The API key’s effective permission is + * exactly as specified with the access property. + *

    + * 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. + *

    + * By default, API keys never expire. You can specify expiration information + * when you create the API keys. + *

    + * Cross-cluster API keys can only be updated with the update cross-cluster API + * key API. Attempting to update them with the update REST API key API or the + * bulk update REST API keys API will result in an error. + * + * @param fn + * a function that initializes a builder to create the + * {@link CreateCrossClusterApiKeyRequest} + * @see Documentation + * on elastic.co + */ + + public final CreateCrossClusterApiKeyResponse createCrossClusterApiKey( + Function> fn) + throws IOException, ElasticsearchException { + return createCrossClusterApiKey(fn.apply(new CreateCrossClusterApiKeyRequest.Builder()).build()); + } + // ----- Endpoint: security.create_service_token /** - * Creates a service accounts token for access without requiring basic + * Create a service account token. + *

    + * Create a service accounts token for access without requiring basic * authentication. * * @see + * Create a service accounts token for access without requiring basic * authentication. * * @param fn @@ -528,7 +666,7 @@ public final CreateServiceTokenResponse createServiceToken( // ----- Endpoint: security.delete_privileges /** - * Removes application privileges. + * Delete application privileges. * * @see Documentation @@ -544,7 +682,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 +701,9 @@ public final DeletePrivilegesResponse deletePrivileges( // ----- Endpoint: security.delete_role /** - * Removes roles in the native realm. + * Delete roles. + *

    + * Delete roles in the native realm. * * @see Documentation @@ -578,7 +718,9 @@ public DeleteRoleResponse deleteRole(DeleteRoleRequest request) throws IOExcepti } /** - * Removes roles in the native realm. + * Delete roles. + *

    + * Delete roles in the native realm. * * @param fn * a function that initializes a builder to create the @@ -596,7 +738,7 @@ public final DeleteRoleResponse deleteRole(FunctionDocumentation @@ -612,7 +754,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 +773,9 @@ public final DeleteRoleMappingResponse deleteRoleMapping( // ----- Endpoint: security.delete_service_token /** - * Deletes a service account token. + * Delete service account tokens. + *

    + * Delete service account tokens for a service in a specified namespace. * * @see Documentation @@ -647,7 +791,9 @@ public DeleteServiceTokenResponse deleteServiceToken(DeleteServiceTokenRequest r } /** - * Deletes a service account token. + * Delete service account tokens. + *

    + * Delete service account tokens for a service in a specified namespace. * * @param fn * a function that initializes a builder to create the @@ -666,7 +812,9 @@ public final DeleteServiceTokenResponse deleteServiceToken( // ----- Endpoint: security.delete_user /** - * Deletes users from the native realm. + * Delete users. + *

    + * Delete users from the native realm. * * @see Documentation @@ -681,7 +829,9 @@ public DeleteUserResponse deleteUser(DeleteUserRequest request) throws IOExcepti } /** - * Deletes users from the native realm. + * Delete users. + *

    + * Delete users from the native realm. * * @param fn * a function that initializes a builder to create the @@ -699,7 +849,9 @@ public final DeleteUserResponse deleteUser(Function + * Disable users in the native realm. * * @see Documentation @@ -714,7 +866,9 @@ public DisableUserResponse disableUser(DisableUserRequest request) throws IOExce } /** - * Disables users in the native realm. + * Disable users. + *

    + * Disable users in the native realm. * * @param fn * a function that initializes a builder to create the @@ -733,7 +887,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. + *

    + * Disable user profiles so that they are not visible in user profile searches. * * @see Documentation @@ -749,7 +905,9 @@ public DisableUserProfileResponse disableUserProfile(DisableUserProfileRequest r } /** - * Disables a user profile so it's not visible in user profile searches. + * Disable a user profile. + *

    + * 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 +926,9 @@ public final DisableUserProfileResponse disableUserProfile( // ----- Endpoint: security.enable_user /** - * Enables users in the native realm. + * Enable users. + *

    + * Enable users in the native realm. * * @see Documentation @@ -783,7 +943,9 @@ public EnableUserResponse enableUser(EnableUserRequest request) throws IOExcepti } /** - * Enables users in the native realm. + * Enable users. + *

    + * Enable users in the native realm. * * @param fn * a function that initializes a builder to create the @@ -801,7 +963,9 @@ public final EnableUserResponse enableUser(Function + * Enable user profiles to make them visible in user profile searches. * * @see Documentation @@ -817,7 +981,9 @@ public EnableUserProfileResponse enableUserProfile(EnableUserProfileRequest requ } /** - * Enables a user profile so it's visible in user profile searches. + * Enable a user profile. + *

    + * Enable user profiles to make them visible in user profile searches. * * @param fn * a function that initializes a builder to create the @@ -836,8 +1002,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. + *

    + * Enable a Kibana instance to configure itself for communication with a secured + * Elasticsearch cluster. * * @see Documentation @@ -851,7 +1019,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. + *

    + * Enroll a new node to allow it to join an existing cluster with security + * features enabled. * * @see Documentation @@ -865,12 +1036,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 manage_own_api_key privilege, this - * API returns only the API keys that you own. If you have - * read_security, manage_api_key or greater privileges - * (including manage_security), this API returns all API keys - * regardless of ownership. + * Get API key information. + *

    + * Retrieves information for one or more API keys. NOTE: If you have only the + * manage_own_api_key privilege, this API returns only the API keys + * that you own. If you have read_security, + * manage_api_key or greater privileges (including + * manage_security), this API returns all API keys regardless of + * ownership. * * @see Documentation @@ -885,12 +1058,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 manage_own_api_key privilege, this - * API returns only the API keys that you own. If you have - * read_security, manage_api_key or greater privileges - * (including manage_security), this API returns all API keys - * regardless of ownership. + * Get API key information. + *

    + * Retrieves information for one or more API keys. NOTE: If you have only the + * manage_own_api_key privilege, this API returns only the API keys + * that you own. If you have read_security, + * manage_api_key or greater privileges (including + * manage_security), this API returns all API keys regardless of + * ownership. * * @param fn * a function that initializes a builder to create the @@ -906,12 +1081,14 @@ public final GetApiKeyResponse getApiKey(Functionmanage_own_api_key privilege, this - * API returns only the API keys that you own. If you have - * read_security, manage_api_key or greater privileges - * (including manage_security), this API returns all API keys - * regardless of ownership. + * Get API key information. + *

    + * Retrieves information for one or more API keys. NOTE: If you have only the + * manage_own_api_key privilege, this API returns only the API keys + * that you own. If you have read_security, + * manage_api_key or greater privileges (including + * manage_security), this API returns all API keys regardless of + * ownership. * * @see Documentation @@ -926,8 +1103,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. + *

    + * Get the list of cluster privileges and index privileges that are available in + * this version of Elasticsearch. * * @see Documentation @@ -941,7 +1120,7 @@ public GetBuiltinPrivilegesResponse getBuiltinPrivileges() throws IOException, E // ----- Endpoint: security.get_privileges /** - * Retrieves application privileges. + * Get application privileges. * * @see Documentation @@ -957,7 +1136,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 +1153,7 @@ public final GetPrivilegesResponse getPrivileges( } /** - * Retrieves application privileges. + * Get application privileges. * * @see Documentation @@ -989,9 +1168,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. + *

    + * 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 Documentation @@ -1006,9 +1187,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. + *

    + * 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 +1207,11 @@ public final GetRoleResponse getRole(Function + * 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 Documentation @@ -1041,7 +1226,12 @@ public GetRoleResponse getRole() throws IOException, ElasticsearchException { // ----- Endpoint: security.get_role_mapping /** - * Retrieves role mappings. + * Get role mappings. + *

    + * 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 Documentation @@ -1057,7 +1247,12 @@ public GetRoleMappingResponse getRoleMapping(GetRoleMappingRequest request) } /** - * Retrieves role mappings. + * Get role mappings. + *

    + * 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 +1269,12 @@ public final GetRoleMappingResponse getRoleMapping( } /** - * Retrieves role mappings. + * Get role mappings. + *

    + * 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 Documentation @@ -1089,8 +1289,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. + *

    + * Get a list of service accounts that match the provided path parameters. * * @see Documentation @@ -1106,8 +1307,9 @@ public GetServiceAccountsResponse getServiceAccounts(GetServiceAccountsRequest r } /** - * This API returns a list of service accounts that match the provided path - * parameter(s). + * Get service accounts. + *

    + * 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 +1326,9 @@ public final GetServiceAccountsResponse getServiceAccounts( } /** - * This API returns a list of service accounts that match the provided path - * parameter(s). + * Get service accounts. + *

    + * Get a list of service accounts that match the provided path parameters. * * @see Documentation @@ -1140,7 +1343,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 Documentation @@ -1156,7 +1359,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 +1378,9 @@ public final GetServiceCredentialsResponse getServiceCredentials( // ----- Endpoint: security.get_token /** - * Creates a bearer token for access without requiring basic authentication. + * Get a token. + *

    + * Create a bearer token for access without requiring basic authentication. * * @see Documentation @@ -1190,7 +1395,9 @@ public GetTokenResponse getToken(GetTokenRequest request) throws IOException, El } /** - * Creates a bearer token for access without requiring basic authentication. + * Get a token. + *

    + * Create a bearer token for access without requiring basic authentication. * * @param fn * a function that initializes a builder to create the @@ -1206,7 +1413,9 @@ public final GetTokenResponse getToken(Function + * Create a bearer token for access without requiring basic authentication. * * @see Documentation @@ -1221,7 +1430,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. + *

    + * Get information about users in the native realm and built-in users. * * @see Documentation @@ -1236,7 +1447,9 @@ public GetUserResponse getUser(GetUserRequest request) throws IOException, Elast } /** - * Retrieves information about users in the native realm and built-in users. + * Get users. + *

    + * 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 +1465,9 @@ public final GetUserResponse getUser(Function + * Get information about users in the native realm and built-in users. * * @see Documentation @@ -1267,7 +1482,7 @@ public GetUserResponse getUser() throws IOException, ElasticsearchException { // ----- Endpoint: security.get_user_privileges /** - * Retrieves security privileges for the logged in user. + * Get user privileges. * * @see Documentation @@ -1283,7 +1498,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 +1515,7 @@ public final GetUserPrivilegesResponse getUserPrivileges( } /** - * Retrieves security privileges for the logged in user. + * Get user privileges. * * @see Documentation @@ -1315,7 +1530,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. + *

    + * Get a user's profile using the unique profile ID. * * @see Documentation @@ -1331,7 +1548,9 @@ public GetUserProfileResponse getUserProfile(GetUserProfileRequest request) } /** - * Retrieves a user's profile using the unique profile ID. + * Get a user profile. + *

    + * Get a user's profile using the unique profile ID. * * @param fn * a function that initializes a builder to create the @@ -1350,15 +1569,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. + *

    + * 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. *

    * 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 +1605,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. + *

    + * 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. *

    * 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 +1645,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. + *

    + * Determine whether the specified user has a specified list of privileges. * * @see Documentation @@ -1439,8 +1663,9 @@ public HasPrivilegesResponse hasPrivileges(HasPrivilegesRequest request) } /** - * Check user privileges. Determines whether the specified user has a specified - * list of privileges. + * Check user privileges. + *

    + * Determine whether the specified user has a specified list of privileges. * * @param fn * a function that initializes a builder to create the @@ -1457,8 +1682,9 @@ public final HasPrivilegesResponse hasPrivileges( } /** - * Check user privileges. Determines whether the specified user has a specified - * list of privileges. + * Check user privileges. + *

    + * Determine whether the specified user has a specified list of privileges. * * @see Documentation @@ -1473,8 +1699,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. + *

    + * Determine whether the users associated with the specified user profile IDs + * have all the requested privileges. * * @see Documentation @@ -1490,8 +1718,10 @@ public HasPrivilegesUserProfileResponse hasPrivilegesUserProfile(HasPrivilegesUs } /** - * Determines whether the users associated with the specified profile IDs have - * all the requested privileges. + * Check user profile privileges. + *

    + * 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 +1740,13 @@ public final HasPrivilegesUserProfileResponse hasPrivilegesUserProfile( // ----- Endpoint: security.invalidate_api_key /** - * Invalidate API keys. Invalidates one or more API keys. The - * manage_api_key privilege allows deleting any API keys. The + * Invalidate API keys. + *

    + * 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 manage_api_key privilege allows deleting any API keys. The * manage_own_api_key only allows deleting API keys that are owned * by the user. In addition, with the manage_own_api_key privilege, * an invalidation request must be issued in one of the three formats: @@ -1519,8 +1754,8 @@ public final HasPrivilegesUserProfileResponse hasPrivilegesUserProfile( *

  • Set the parameter owner=true.
    • *
  • Or, set both username and realm_name to match * the user’s identity.
    • - *
  • Or, if the request is issued by an API key, i.e. an API key invalidates - * itself, specify its ID in the ids field.
    • + *
  • Or, if the request is issued by an API key, that is to say an API key + * invalidates itself, specify its ID in the ids field.
    • * * * @see     manage_api_key privilege allows deleting any API keys. The + * Invalidate API keys. + *

    + * 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 manage_api_key privilege allows deleting any API keys. The * manage_own_api_key only allows deleting API keys that are owned * by the user. In addition, with the manage_own_api_key privilege, * an invalidation request must be issued in one of the three formats: @@ -1546,8 +1786,8 @@ public InvalidateApiKeyResponse invalidateApiKey(InvalidateApiKeyRequest request *

  • Set the parameter owner=true.
    • *
  • Or, set both username and realm_name to match * the user’s identity.
    • - *
  • Or, if the request is issued by an API key, i.e. an API key invalidates - * itself, specify its ID in the ids field.
    • + *
  • Or, if the request is issued by an API key, that is to say an API key + * invalidates itself, specify its ID in the ids field.
    • * * * @param fn @@ -1565,8 +1805,13 @@ public final InvalidateApiKeyResponse invalidateApiKey( } /** - * Invalidate API keys. Invalidates one or more API keys. The - * manage_api_key privilege allows deleting any API keys. The + * Invalidate API keys. + *

    + * 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 manage_api_key privilege allows deleting any API keys. The * manage_own_api_key only allows deleting API keys that are owned * by the user. In addition, with the manage_own_api_key privilege, * an invalidation request must be issued in one of the three formats: @@ -1574,8 +1819,8 @@ public final InvalidateApiKeyResponse invalidateApiKey( *

  • Set the parameter owner=true.
    • *
  • Or, set both username and realm_name to match * the user’s identity.
    • - *
  • Or, if the request is issued by an API key, i.e. an API key invalidates - * itself, specify its ID in the ids field.
    • + *
  • Or, if the request is issued by an API key, that is to say an API key + * invalidates itself, specify its ID in the ids field.
    • * * * @see     + * 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 + * xpack.security.authc.token.timeout setting. + *

    + * 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 Documentation @@ -1607,7 +1861,16 @@ public InvalidateTokenResponse invalidateToken(InvalidateTokenRequest request) } /** - * Invalidates one or more access tokens or refresh tokens. + * Invalidate a token. + *

    + * 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 + * xpack.security.authc.token.timeout setting. + *

    + * 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 +1887,16 @@ public final InvalidateTokenResponse invalidateToken( } /** - * Invalidates one or more access tokens or refresh tokens. + * Invalidate a token. + *

    + * 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 + * xpack.security.authc.token.timeout setting. + *

    + * 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 Documentation @@ -1639,7 +1911,7 @@ public InvalidateTokenResponse invalidateToken() throws IOException, Elasticsear // ----- Endpoint: security.put_privileges /** - * Adds or updates application privileges. + * Create or update application privileges. * * @see Documentation @@ -1655,7 +1927,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 +1944,7 @@ public final PutPrivilegesResponse putPrivileges( } /** - * Adds or updates application privileges. + * Create or update application privileges. * * @see Documentation @@ -1687,9 +1959,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. + *

    + * 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 Documentation @@ -1704,9 +1979,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. + *

    + * 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 +2002,17 @@ public final PutRoleResponse putRole(Function + * 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. + *

    + * 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 Documentation @@ -1740,7 +2028,17 @@ public PutRoleMappingResponse putRoleMapping(PutRoleMappingRequest request) } /** - * Creates and updates role mappings. + * Create or update role mappings. + *

    + * 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. + *

    + * 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 +2057,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. + *

    + * 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 Documentation @@ -1775,8 +2076,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. + *

    + * 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 +2098,10 @@ public final PutUserResponse putUser(Function + * Get a paginated list of API keys and their information. You can optionally + * filter the results with a query. * * @see Documentation @@ -1810,8 +2116,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. + *

    + * 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 +2136,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. + *

    + * Get a paginated list of API keys and their information. You can optionally + * filter the results with a query. * * @see Documentation @@ -1844,8 +2154,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. + *

    + * Get roles in a paginated manner. You can optionally filter the results with a + * query. * * @see Documentation @@ -1860,8 +2172,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. + *

    + * 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 +2191,10 @@ public final QueryRoleResponse queryRole(Function + * Get roles in a paginated manner. You can optionally filter the results with a + * query. * * @see Documentation @@ -1893,8 +2209,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. + *

    + * Get information for users in a paginated manner. You can optionally filter + * the results with a query. * * @see Documentation @@ -1909,8 +2227,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. + *

    + * 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 +2246,10 @@ public final QueryUserResponse queryUser(Function + * Get information for users in a paginated manner. You can optionally filter + * the results with a query. * * @see Documentation @@ -1942,7 +2264,9 @@ public QueryUserResponse queryUser() throws IOException, ElasticsearchException // ----- Endpoint: security.saml_authenticate /** - * Submits a SAML Response message to Elasticsearch for consumption. + * Authenticate SAML. + *

    + * Submits a SAML response message to Elasticsearch for consumption. * * @see Documentation @@ -1958,7 +2282,9 @@ public SamlAuthenticateResponse samlAuthenticate(SamlAuthenticateRequest request } /** - * Submits a SAML Response message to Elasticsearch for consumption. + * Authenticate SAML. + *

    + * Submits a SAML response message to Elasticsearch for consumption. * * @param fn * a function that initializes a builder to create the @@ -1977,6 +2303,8 @@ public final SamlAuthenticateResponse samlAuthenticate( // ----- Endpoint: security.saml_complete_logout /** + * Logout of SAML completely. + *

    * Verifies the logout response sent from the SAML IdP. * * @see * Verifies the logout response sent from the SAML IdP. * * @param fn @@ -2012,6 +2342,8 @@ public final BooleanResponse samlCompleteLogout( // ----- Endpoint: security.saml_invalidate /** + * Invalidate SAML. + *

    * Submits a SAML LogoutRequest message to Elasticsearch for consumption. * * @see * Submits a SAML LogoutRequest message to Elasticsearch for consumption. * * @param fn @@ -2047,6 +2381,8 @@ public final SamlInvalidateResponse samlInvalidate( // ----- Endpoint: security.saml_logout /** + * Logout of SAML. + *

    * Submits a request to invalidate an access token and refresh token. * * @see * Submits a request to invalidate an access token and refresh token. * * @param fn @@ -2080,8 +2418,11 @@ public final SamlLogoutResponse samlLogout(Function + * Creates a SAML authentication request (<AuthnRequest>) as + * a URL string, based on the configuration of the respective SAML realm in + * Elasticsearch. * * @see Documentation @@ -2097,8 +2438,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. + *

    + * Creates a SAML authentication request (<AuthnRequest>) 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 +2459,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. + *

    + * Creates a SAML authentication request (<AuthnRequest>) as + * a URL string, based on the configuration of the respective SAML realm in + * Elasticsearch. * * @see Documentation @@ -2131,6 +2478,8 @@ public SamlPrepareAuthenticationResponse samlPrepareAuthentication() throws IOEx // ----- Endpoint: security.saml_service_provider_metadata /** + * Create SAML service provider metadata. + *

    * Generate SAML metadata for a SAML 2.0 Service Provider. * * @see * Generate SAML metadata for a SAML 2.0 Service Provider. * * @param fn @@ -2166,6 +2517,8 @@ public final SamlServiceProviderMetadataResponse samlServiceProviderMetadata( // ----- Endpoint: security.suggest_user_profiles /** + * Suggest a user profile. + *

    * Get suggestions for user profiles that match specified search criteria. * * @see * Get suggestions for user profiles that match specified search criteria. * * @param fn @@ -2199,6 +2554,8 @@ public final SuggestUserProfilesResponse suggestUserProfiles( } /** + * Suggest a user profile. + *

    * Get suggestions for user profiles that match specified search criteria. * * @see role_descriptors 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 role_descriptors 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 run_as 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. + *

    + * 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 role_descriptors 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 role_descriptors 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 + * run_as 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 +2605,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 role_descriptors 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 role_descriptors 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 run_as 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. + *

    + * 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 role_descriptors 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 role_descriptors 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 + * run_as 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. * @@ -2279,11 +2640,54 @@ public final UpdateApiKeyResponse updateApiKey( return updateApiKey(fn.apply(new UpdateApiKeyRequest.Builder()).build()); } + // ----- Endpoint: security.update_cross_cluster_api_key + + /** + * Update a cross-cluster API key. + *

    + * Update the attributes of an existing cross-cluster API key, which is used for + * API key based remote cluster access. + * + * @see Documentation + * on elastic.co + */ + + public UpdateCrossClusterApiKeyResponse updateCrossClusterApiKey(UpdateCrossClusterApiKeyRequest request) + throws IOException, ElasticsearchException { + @SuppressWarnings("unchecked") + JsonEndpoint endpoint = (JsonEndpoint) UpdateCrossClusterApiKeyRequest._ENDPOINT; + + return this.transport.performRequest(request, endpoint, this.transportOptions); + } + + /** + * Update a cross-cluster API key. + *

    + * Update the attributes of an existing cross-cluster API key, which is used for + * API key based remote cluster access. + * + * @param fn + * a function that initializes a builder to create the + * {@link UpdateCrossClusterApiKeyRequest} + * @see Documentation + * on elastic.co + */ + + public final UpdateCrossClusterApiKeyResponse updateCrossClusterApiKey( + Function> fn) + throws IOException, ElasticsearchException { + return updateCrossClusterApiKey(fn.apply(new UpdateCrossClusterApiKeyRequest.Builder()).build()); + } + // ----- 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. + *

    + * Update specific data for the user profile that is associated with a unique + * ID. * * @see Documentation @@ -2299,8 +2703,10 @@ public UpdateUserProfileDataResponse updateUserProfileData(UpdateUserProfileData } /** - * Updates specific data for the user profile that's associated with the - * specified unique ID. + * Update user profile data. + *

    + * 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. + *

    + * Enable user profiles to make them visible in user profile searches. * * @see 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. + *

    + * Enable users in the native realm. * * @see API * specification 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. + *

    + * Enable a Kibana instance to configure itself for communication with a secured + * Elasticsearch cluster. * * @see API * specification 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. + *

    + * Enroll a new node to allow it to join an existing cluster with security + * features enabled. * * @see API * specification 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 manage_own_api_key privilege, this - * API returns only the API keys that you own. If you have - * read_security, manage_api_key or greater privileges - * (including manage_security), this API returns all API keys - * regardless of ownership. + * Get API key information. + *

    + * Retrieves information for one or more API keys. NOTE: If you have only the + * manage_own_api_key privilege, this API returns only the API keys + * that you own. If you have read_security, + * manage_api_key or greater privileges (including + * manage_security), this API returns all API keys regardless of + * ownership. * * @see API * specification 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. + *

    + * Get the list of cluster privileges and index privileges that are available in + * this version of Elasticsearch. * * @see 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 API * specification 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. + *

    + * 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 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. + *

    + * 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 API * specification 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. + *

    + * Get a list of service accounts that match the provided path parameters. * * @see 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 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. + *

    + * Create a bearer token for access without requiring basic authentication. * * @see API * specification 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 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. + *

    + * Get a user's profile using the unique profile ID. * * @see 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. + *

    + * Get information about users in the native realm and built-in users. * * @see API * specification 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. + *

    + * 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. *

    * 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. + *

    + * Determine whether the specified user has a specified list of privileges. * * @see API * specification 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. + *

    + * Determine whether the users associated with the specified user profile IDs + * have all the requested privileges. * * @see 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 - * manage_api_key privilege allows deleting any API keys. The + * Invalidate API keys. + *

    + * 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 manage_api_key privilege allows deleting any API keys. The * manage_own_api_key only allows deleting API keys that are owned * by the user. In addition, with the manage_own_api_key privilege, * an invalidation request must be issued in one of the three formats: @@ -67,8 +72,8 @@ *

  • Set the parameter owner=true.
    • *
  • Or, set both username and realm_name to match * the user’s identity.
    • - *
  • Or, if the request is issued by an API key, i.e. an API key invalidates - * itself, specify its ID in the ids field.
    • + *
  • Or, if the request is issued by an API key, that is to say an API key + * invalidates itself, specify its ID in the ids field.
    • * * * @see     + * 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 + * xpack.security.authc.token.timeout setting. + *

    + * 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 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 API * specification 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. + *

    + * 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. + *

    + * 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 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. + *

    + * 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 API * specification 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. + *

    + * 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 API * specification 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. + *

    + * Get a paginated list of API keys and their information. You can optionally + * filter the results with a query. * * @see API * specification 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. + *

    + * Get roles in a paginated manner. You can optionally filter the results with a + * query. * * @see API * specification 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. + *

    + * Get information for users in a paginated manner. You can optionally filter + * the results with a query. * * @see API * specification diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/ReplicationAccess.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/ReplicationAccess.java new file mode 100644 index 000000000..5bd2ca9e1 --- /dev/null +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/ReplicationAccess.java @@ -0,0 +1,220 @@ +/* + * 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.security; + +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.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: security._types.ReplicationAccess + +/** + * + * @see API + * specification + */ +@JsonpDeserializable +public class ReplicationAccess implements JsonpSerializable { + private final List names; + + @Nullable + private final Boolean allowRestrictedIndices; + + // --------------------------------------------------------------------------------------------- + + private ReplicationAccess(Builder builder) { + + this.names = ApiTypeHelper.unmodifiableRequired(builder.names, this, "names"); + this.allowRestrictedIndices = builder.allowRestrictedIndices; + + } + + public static ReplicationAccess of(Function> fn) { + return fn.apply(new Builder()).build(); + } + + /** + * Required - A list of indices (or index name patterns) to which the + * permissions in this entry apply. + *

    + * API name: {@code names} + */ + public final List names() { + return this.names; + } + + /** + * This needs to be set to true if the patterns in the names field should cover + * system indices. + *

    + * API name: {@code allow_restricted_indices} + */ + @Nullable + public final Boolean allowRestrictedIndices() { + return this.allowRestrictedIndices; + } + + /** + * 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.names)) { + generator.writeKey("names"); + generator.writeStartArray(); + for (String item0 : this.names) { + generator.write(item0); + + } + generator.writeEnd(); + + } + if (this.allowRestrictedIndices != null) { + generator.writeKey("allow_restricted_indices"); + generator.write(this.allowRestrictedIndices); + + } + + } + + @Override + public String toString() { + return JsonpUtils.toString(this); + } + + // --------------------------------------------------------------------------------------------- + + /** + * Builder for {@link ReplicationAccess}. + */ + + public static class Builder extends WithJsonObjectBuilderBase implements ObjectBuilder { + private List names; + + @Nullable + private Boolean allowRestrictedIndices; + + /** + * Required - A list of indices (or index name patterns) to which the + * permissions in this entry apply. + *

    + * API name: {@code names} + *

    + * Adds all elements of list to names. + */ + public final Builder names(List list) { + this.names = _listAddAll(this.names, list); + return this; + } + + /** + * Required - A list of indices (or index name patterns) to which the + * permissions in this entry apply. + *

    + * API name: {@code names} + *

    + * Adds one or more values to names. + */ + public final Builder names(String value, String... values) { + this.names = _listAdd(this.names, value, values); + return this; + } + + /** + * This needs to be set to true if the patterns in the names field should cover + * system indices. + *

    + * API name: {@code allow_restricted_indices} + */ + public final Builder allowRestrictedIndices(@Nullable Boolean value) { + this.allowRestrictedIndices = value; + return this; + } + + @Override + protected Builder self() { + return this; + } + + /** + * Builds a {@link ReplicationAccess}. + * + * @throws NullPointerException + * if some of the required fields are null. + */ + public ReplicationAccess build() { + _checkSingleUse(); + + return new ReplicationAccess(this); + } + } + + // --------------------------------------------------------------------------------------------- + + /** + * Json deserializer for {@link ReplicationAccess} + */ + public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer + .lazy(Builder::new, ReplicationAccess::setupReplicationAccessDeserializer); + + protected static void setupReplicationAccessDeserializer(ObjectDeserializer op) { + + op.add(Builder::names, JsonpDeserializer.arrayDeserializer(JsonpDeserializer.stringDeserializer()), "names"); + op.add(Builder::allowRestrictedIndices, JsonpDeserializer.booleanDeserializer(), "allow_restricted_indices"); + + } + +} 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. + *

    + * Submits a SAML response message to Elasticsearch for consumption. * * @see 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. + *

    * Verifies the logout response sent from the SAML IdP. * * @see * Submits a SAML LogoutRequest message to Elasticsearch for consumption. * * @see * Submits a request to invalidate an access token and refresh token. * * @see 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. + *

    + * Creates a SAML authentication request (<AuthnRequest>) as + * a URL string, based on the configuration of the respective SAML realm in + * Elasticsearch. * * @see 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. + *

    * Generate SAML metadata for a SAML 2.0 Service Provider. * * @see API + * specification + */ +@JsonpDeserializable +public class SearchAccess implements JsonpSerializable { + @Nullable + private final FieldSecurity fieldSecurity; + + private final List names; + + @Nullable + private final IndicesPrivilegesQuery query; + + @Nullable + private final Boolean allowRestrictedIndices; + + // --------------------------------------------------------------------------------------------- + + private SearchAccess(Builder builder) { + + this.fieldSecurity = builder.fieldSecurity; + this.names = ApiTypeHelper.unmodifiableRequired(builder.names, this, "names"); + this.query = builder.query; + this.allowRestrictedIndices = builder.allowRestrictedIndices; + + } + + public static SearchAccess of(Function> fn) { + return fn.apply(new Builder()).build(); + } + + /** + * The document fields that the owners of the role have read access to. + *

    + * API name: {@code field_security} + */ + @Nullable + public final FieldSecurity fieldSecurity() { + return this.fieldSecurity; + } + + /** + * Required - A list of indices (or index name patterns) to which the + * permissions in this entry apply. + *

    + * API name: {@code names} + */ + public final List names() { + return this.names; + } + + /** + * A search query that defines the documents the owners of the role have access + * to. A document within the specified indices must match this query for it to + * be accessible by the owners of the role. + *

    + * API name: {@code query} + */ + @Nullable + public final IndicesPrivilegesQuery query() { + return this.query; + } + + /** + * Set to true if using wildcard or regular expressions for + * patterns that cover restricted indices. Implicitly, restricted indices have + * limited privileges that can cause pattern tests to fail. If restricted + * indices are explicitly included in the names list, Elasticsearch + * checks privileges against these indices regardless of the value set for + * allow_restricted_indices. + *

    + * API name: {@code allow_restricted_indices} + */ + @Nullable + public final Boolean allowRestrictedIndices() { + return this.allowRestrictedIndices; + } + + /** + * 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 (this.fieldSecurity != null) { + generator.writeKey("field_security"); + this.fieldSecurity.serialize(generator, mapper); + + } + if (ApiTypeHelper.isDefined(this.names)) { + generator.writeKey("names"); + generator.writeStartArray(); + for (String item0 : this.names) { + generator.write(item0); + + } + generator.writeEnd(); + + } + if (this.query != null) { + generator.writeKey("query"); + this.query.serialize(generator, mapper); + + } + if (this.allowRestrictedIndices != null) { + generator.writeKey("allow_restricted_indices"); + generator.write(this.allowRestrictedIndices); + + } + + } + + @Override + public String toString() { + return JsonpUtils.toString(this); + } + + // --------------------------------------------------------------------------------------------- + + /** + * Builder for {@link SearchAccess}. + */ + + public static class Builder extends WithJsonObjectBuilderBase implements ObjectBuilder { + @Nullable + private FieldSecurity fieldSecurity; + + private List names; + + @Nullable + private IndicesPrivilegesQuery query; + + @Nullable + private Boolean allowRestrictedIndices; + + /** + * The document fields that the owners of the role have read access to. + *

    + * API name: {@code field_security} + */ + public final Builder fieldSecurity(@Nullable FieldSecurity value) { + this.fieldSecurity = value; + return this; + } + + /** + * The document fields that the owners of the role have read access to. + *

    + * API name: {@code field_security} + */ + public final Builder fieldSecurity(Function> fn) { + return this.fieldSecurity(fn.apply(new FieldSecurity.Builder()).build()); + } + + /** + * Required - A list of indices (or index name patterns) to which the + * permissions in this entry apply. + *

    + * API name: {@code names} + *

    + * Adds all elements of list to names. + */ + public final Builder names(List list) { + this.names = _listAddAll(this.names, list); + return this; + } + + /** + * Required - A list of indices (or index name patterns) to which the + * permissions in this entry apply. + *

    + * API name: {@code names} + *

    + * Adds one or more values to names. + */ + public final Builder names(String value, String... values) { + this.names = _listAdd(this.names, value, values); + return this; + } + + /** + * A search query that defines the documents the owners of the role have access + * to. A document within the specified indices must match this query for it to + * be accessible by the owners of the role. + *

    + * API name: {@code query} + */ + public final Builder query(@Nullable IndicesPrivilegesQuery value) { + this.query = value; + return this; + } + + /** + * A search query that defines the documents the owners of the role have access + * to. A document within the specified indices must match this query for it to + * be accessible by the owners of the role. + *

    + * API name: {@code query} + */ + public final Builder query(Function> fn) { + return this.query(fn.apply(new IndicesPrivilegesQuery.Builder()).build()); + } + + /** + * Set to true if using wildcard or regular expressions for + * patterns that cover restricted indices. Implicitly, restricted indices have + * limited privileges that can cause pattern tests to fail. If restricted + * indices are explicitly included in the names list, Elasticsearch + * checks privileges against these indices regardless of the value set for + * allow_restricted_indices. + *

    + * API name: {@code allow_restricted_indices} + */ + public final Builder allowRestrictedIndices(@Nullable Boolean value) { + this.allowRestrictedIndices = value; + return this; + } + + @Override + protected Builder self() { + return this; + } + + /** + * Builds a {@link SearchAccess}. + * + * @throws NullPointerException + * if some of the required fields are null. + */ + public SearchAccess build() { + _checkSingleUse(); + + return new SearchAccess(this); + } + } + + // --------------------------------------------------------------------------------------------- + + /** + * Json deserializer for {@link SearchAccess} + */ + public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer.lazy(Builder::new, + SearchAccess::setupSearchAccessDeserializer); + + protected static void setupSearchAccessDeserializer(ObjectDeserializer op) { + + op.add(Builder::fieldSecurity, FieldSecurity._DESERIALIZER, "field_security"); + op.add(Builder::names, JsonpDeserializer.arrayDeserializer(JsonpDeserializer.stringDeserializer()), "names"); + op.add(Builder::query, IndicesPrivilegesQuery._DESERIALIZER, "query"); + op.add(Builder::allowRestrictedIndices, JsonpDeserializer.booleanDeserializer(), "allow_restricted_indices"); + + } + +} 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. + *

    * Get suggestions for user profiles that match specified search criteria. * * @see role_descriptors 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 role_descriptors 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 run_as 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. + *

    + * 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 role_descriptors 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 role_descriptors 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 + * run_as 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/UpdateCrossClusterApiKeyRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/UpdateCrossClusterApiKeyRequest.java new file mode 100644 index 000000000..348a0842f --- /dev/null +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/UpdateCrossClusterApiKeyRequest.java @@ -0,0 +1,371 @@ +/* + * 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.security; + +import co.elastic.clients.elasticsearch._types.ErrorResponse; +import co.elastic.clients.elasticsearch._types.RequestBase; +import co.elastic.clients.elasticsearch._types.Time; +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: security.update_cross_cluster_api_key.Request + +/** + * Update a cross-cluster API key. + *

    + * Update the attributes of an existing cross-cluster API key, which is used for + * API key based remote cluster access. + * + * @see API + * specification + */ +@JsonpDeserializable +public class UpdateCrossClusterApiKeyRequest extends RequestBase implements JsonpSerializable { + private final Access access; + + @Nullable + private final Time expiration; + + private final String id; + + private final Map metadata; + + // --------------------------------------------------------------------------------------------- + + private UpdateCrossClusterApiKeyRequest(Builder builder) { + + this.access = ApiTypeHelper.requireNonNull(builder.access, this, "access"); + this.expiration = builder.expiration; + this.id = ApiTypeHelper.requireNonNull(builder.id, this, "id"); + this.metadata = ApiTypeHelper.unmodifiable(builder.metadata); + + } + + public static UpdateCrossClusterApiKeyRequest of( + Function> fn) { + return fn.apply(new Builder()).build(); + } + + /** + * Required - The access to be granted to this API key. The access is composed + * of permissions for cross cluster search and cross cluster replication. At + * least one of them must be specified. When specified, the new access + * assignment fully replaces the previously assigned access. + *

    + * API name: {@code access} + */ + public final Access access() { + return this.access; + } + + /** + * Expiration time for the API key. By default, API keys never expire. This + * property can be omitted to leave the value unchanged. + *

    + * API name: {@code expiration} + */ + @Nullable + public final Time expiration() { + return this.expiration; + } + + /** + * Required - The ID of the cross-cluster API key to update. + *

    + * API name: {@code id} + */ + public final String id() { + return this.id; + } + + /** + * Arbitrary metadata that you want to associate with the API key. It supports + * nested data structure. Within the metadata object, keys beginning with + * _ are reserved for system usage. When specified, this + * information fully replaces metadata previously associated with the API key. + *

    + * API name: {@code metadata} + */ + public final Map metadata() { + return this.metadata; + } + + /** + * 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("access"); + this.access.serialize(generator, mapper); + + if (this.expiration != null) { + generator.writeKey("expiration"); + this.expiration.serialize(generator, mapper); + + } + if (ApiTypeHelper.isDefined(this.metadata)) { + generator.writeKey("metadata"); + generator.writeStartObject(); + for (Map.Entry item0 : this.metadata.entrySet()) { + generator.writeKey(item0.getKey()); + item0.getValue().serialize(generator, mapper); + + } + generator.writeEnd(); + + } + + } + + // --------------------------------------------------------------------------------------------- + + /** + * Builder for {@link UpdateCrossClusterApiKeyRequest}. + */ + + public static class Builder extends RequestBase.AbstractBuilder + implements + ObjectBuilder { + private Access access; + + @Nullable + private Time expiration; + + private String id; + + @Nullable + private Map metadata; + + /** + * Required - The access to be granted to this API key. The access is composed + * of permissions for cross cluster search and cross cluster replication. At + * least one of them must be specified. When specified, the new access + * assignment fully replaces the previously assigned access. + *

    + * API name: {@code access} + */ + public final Builder access(Access value) { + this.access = value; + return this; + } + + /** + * Required - The access to be granted to this API key. The access is composed + * of permissions for cross cluster search and cross cluster replication. At + * least one of them must be specified. When specified, the new access + * assignment fully replaces the previously assigned access. + *

    + * API name: {@code access} + */ + public final Builder access(Function> fn) { + return this.access(fn.apply(new Access.Builder()).build()); + } + + /** + * Expiration time for the API key. By default, API keys never expire. This + * property can be omitted to leave the value unchanged. + *

    + * API name: {@code expiration} + */ + public final Builder expiration(@Nullable Time value) { + this.expiration = value; + return this; + } + + /** + * Expiration time for the API key. By default, API keys never expire. This + * property can be omitted to leave the value unchanged. + *

    + * API name: {@code expiration} + */ + public final Builder expiration(Function> fn) { + return this.expiration(fn.apply(new Time.Builder()).build()); + } + + /** + * Required - The ID of the cross-cluster API key to update. + *

    + * API name: {@code id} + */ + public final Builder id(String value) { + this.id = value; + return this; + } + + /** + * Arbitrary metadata that you want to associate with the API key. It supports + * nested data structure. Within the metadata object, keys beginning with + * _ are reserved for system usage. When specified, this + * information fully replaces metadata previously associated with the API key. + *

    + * API name: {@code metadata} + *

    + * Adds all entries of map to metadata. + */ + public final Builder metadata(Map map) { + this.metadata = _mapPutAll(this.metadata, map); + return this; + } + + /** + * Arbitrary metadata that you want to associate with the API key. It supports + * nested data structure. Within the metadata object, keys beginning with + * _ are reserved for system usage. When specified, this + * information fully replaces metadata previously associated with the API key. + *

    + * API name: {@code metadata} + *

    + * Adds an entry to metadata. + */ + public final Builder metadata(String key, JsonData value) { + this.metadata = _mapPut(this.metadata, key, value); + return this; + } + + @Override + protected Builder self() { + return this; + } + + /** + * Builds a {@link UpdateCrossClusterApiKeyRequest}. + * + * @throws NullPointerException + * if some of the required fields are null. + */ + public UpdateCrossClusterApiKeyRequest build() { + _checkSingleUse(); + + return new UpdateCrossClusterApiKeyRequest(this); + } + } + + // --------------------------------------------------------------------------------------------- + + /** + * Json deserializer for {@link UpdateCrossClusterApiKeyRequest} + */ + public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer + .lazy(Builder::new, UpdateCrossClusterApiKeyRequest::setupUpdateCrossClusterApiKeyRequestDeserializer); + + protected static void setupUpdateCrossClusterApiKeyRequestDeserializer( + ObjectDeserializer op) { + + op.add(Builder::access, Access._DESERIALIZER, "access"); + op.add(Builder::expiration, Time._DESERIALIZER, "expiration"); + op.add(Builder::metadata, JsonpDeserializer.stringMapDeserializer(JsonData._DESERIALIZER), "metadata"); + + } + + // --------------------------------------------------------------------------------------------- + + /** + * Endpoint "{@code security.update_cross_cluster_api_key}". + */ + public static final Endpoint _ENDPOINT = new SimpleEndpoint<>( + "es/security.update_cross_cluster_api_key", + + // Request method + request -> { + return "PUT"; + + }, + + // Request path + request -> { + final int _id = 1 << 0; + + int propsSet = 0; + + propsSet |= _id; + + if (propsSet == (_id)) { + StringBuilder buf = new StringBuilder(); + buf.append("/_security"); + buf.append("/cross_cluster"); + buf.append("/api_key"); + buf.append("/"); + SimpleEndpoint.pathEncode(request.id, buf); + return buf.toString(); + } + throw SimpleEndpoint.noPathTemplateFound("path"); + + }, + + // Path parameters + request -> { + Map params = new HashMap<>(); + final int _id = 1 << 0; + + int propsSet = 0; + + propsSet |= _id; + + if (propsSet == (_id)) { + params.put("id", request.id); + } + return params; + }, + + // Request parameters + request -> { + return Collections.emptyMap(); + + }, SimpleEndpoint.emptyMap(), true, UpdateCrossClusterApiKeyResponse._DESERIALIZER); +} diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/security/UpdateCrossClusterApiKeyResponse.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/UpdateCrossClusterApiKeyResponse.java new file mode 100644 index 000000000..c99ec7f5c --- /dev/null +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/security/UpdateCrossClusterApiKeyResponse.java @@ -0,0 +1,163 @@ +/* + * 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.security; + +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.Boolean; +import java.util.Objects; +import java.util.function.Function; + +//---------------------------------------------------------------- +// 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: security.update_cross_cluster_api_key.Response + +/** + * + * @see API + * specification + */ +@JsonpDeserializable +public class UpdateCrossClusterApiKeyResponse implements JsonpSerializable { + private final boolean updated; + + // --------------------------------------------------------------------------------------------- + + private UpdateCrossClusterApiKeyResponse(Builder builder) { + + this.updated = ApiTypeHelper.requireNonNull(builder.updated, this, "updated"); + + } + + public static UpdateCrossClusterApiKeyResponse of( + Function> fn) { + return fn.apply(new Builder()).build(); + } + + /** + * Required - If true, the API key was updated. If + * false, the API key didn’t change because no change was detected. + *

    + * API name: {@code updated} + */ + public final boolean updated() { + return this.updated; + } + + /** + * 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("updated"); + generator.write(this.updated); + + } + + @Override + public String toString() { + return JsonpUtils.toString(this); + } + + // --------------------------------------------------------------------------------------------- + + /** + * Builder for {@link UpdateCrossClusterApiKeyResponse}. + */ + + public static class Builder extends WithJsonObjectBuilderBase + implements + ObjectBuilder { + private Boolean updated; + + /** + * Required - If true, the API key was updated. If + * false, the API key didn’t change because no change was detected. + *

    + * API name: {@code updated} + */ + public final Builder updated(boolean value) { + this.updated = value; + return this; + } + + @Override + protected Builder self() { + return this; + } + + /** + * Builds a {@link UpdateCrossClusterApiKeyResponse}. + * + * @throws NullPointerException + * if some of the required fields are null. + */ + public UpdateCrossClusterApiKeyResponse build() { + _checkSingleUse(); + + return new UpdateCrossClusterApiKeyResponse(this); + } + } + + // --------------------------------------------------------------------------------------------- + + /** + * Json deserializer for {@link UpdateCrossClusterApiKeyResponse} + */ + public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer + .lazy(Builder::new, UpdateCrossClusterApiKeyResponse::setupUpdateCrossClusterApiKeyResponseDeserializer); + + protected static void setupUpdateCrossClusterApiKeyResponseDeserializer( + ObjectDeserializer op) { + + op.add(Builder::updated, JsonpDeserializer.booleanDeserializer(), "updated"); + + } + +} 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. + *

    + * Update specific data for the user profile that is associated with a unique + * ID. * * @see API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/tasks/ListRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/tasks/ListRequest.java index 1a2544985..c212aa37b 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/tasks/ListRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/tasks/ListRequest.java @@ -79,7 +79,7 @@ public class ListRequest extends RequestBase { @Nullable private final Time masterTimeout; - private final List nodeId; + private final List nodes; @Nullable private final String parentTaskId; @@ -98,7 +98,7 @@ private ListRequest(Builder builder) { this.detailed = builder.detailed; this.groupBy = builder.groupBy; this.masterTimeout = builder.masterTimeout; - this.nodeId = ApiTypeHelper.unmodifiable(builder.nodeId); + this.nodes = ApiTypeHelper.unmodifiable(builder.nodes); this.parentTaskId = builder.parentTaskId; this.timeout = builder.timeout; this.waitForCompletion = builder.waitForCompletion; @@ -154,10 +154,10 @@ public final Time masterTimeout() { /** * Comma-separated list of node IDs or names used to limit returned information. *

    - * API name: {@code node_id} + * API name: {@code nodes} */ - public final List nodeId() { - return this.nodeId; + public final List nodes() { + return this.nodes; } /** @@ -212,7 +212,7 @@ public static class Builder extends RequestBase.AbstractBuilder impleme private Time masterTimeout; @Nullable - private List nodeId; + private List nodes; @Nullable private String parentTaskId; @@ -294,24 +294,24 @@ public final Builder masterTimeout(Function> f /** * Comma-separated list of node IDs or names used to limit returned information. *

    - * API name: {@code node_id} + * API name: {@code nodes} *

    - * Adds all elements of list to nodeId. + * Adds all elements of list to nodes. */ - public final Builder nodeId(List list) { - this.nodeId = _listAddAll(this.nodeId, list); + public final Builder nodes(List list) { + this.nodes = _listAddAll(this.nodes, list); return this; } /** * Comma-separated list of node IDs or names used to limit returned information. *

    - * API name: {@code node_id} + * API name: {@code nodes} *

    - * Adds one or more values to nodeId. + * Adds one or more values to nodes. */ - public final Builder nodeId(String value, String... values) { - this.nodeId = _listAdd(this.nodeId, value, values); + public final Builder nodes(String value, String... values) { + this.nodes = _listAdd(this.nodes, value, values); return this; } @@ -406,6 +406,9 @@ public ListRequest build() { if (request.masterTimeout != null) { params.put("master_timeout", request.masterTimeout._toJsonString()); } + if (ApiTypeHelper.isDefined(request.nodes)) { + params.put("nodes", request.nodes.stream().map(v -> v).collect(Collectors.joining(","))); + } if (request.parentTaskId != null) { params.put("parent_task_id", request.parentTaskId); } @@ -424,9 +427,6 @@ public ListRequest build() { if (request.timeout != null) { params.put("timeout", request.timeout._toJsonString()); } - if (ApiTypeHelper.isDefined(request.nodeId)) { - params.put("node_id", request.nodeId.stream().map(v -> v).collect(Collectors.joining(","))); - } return params; }, SimpleEndpoint.emptyMap(), false, ListResponse._DESERIALIZER); diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/xpack/info/Features.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/xpack/info/Features.java index 8e1562695..c13fe9212 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/xpack/info/Features.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/xpack/info/Features.java @@ -84,6 +84,8 @@ public class Features implements JsonpSerializable { private final Feature logstash; + private final Feature logsdb; + private final Feature ml; private final Feature monitoring; @@ -130,6 +132,7 @@ private Features(Builder builder) { this.graph = ApiTypeHelper.requireNonNull(builder.graph, this, "graph"); this.ilm = ApiTypeHelper.requireNonNull(builder.ilm, this, "ilm"); this.logstash = ApiTypeHelper.requireNonNull(builder.logstash, this, "logstash"); + this.logsdb = ApiTypeHelper.requireNonNull(builder.logsdb, this, "logsdb"); this.ml = ApiTypeHelper.requireNonNull(builder.ml, this, "ml"); this.monitoring = ApiTypeHelper.requireNonNull(builder.monitoring, this, "monitoring"); this.rollup = ApiTypeHelper.requireNonNull(builder.rollup, this, "rollup"); @@ -243,6 +246,13 @@ public final Feature logstash() { return this.logstash; } + /** + * Required - API name: {@code logsdb} + */ + public final Feature logsdb() { + return this.logsdb; + } + /** * Required - API name: {@code ml} */ @@ -392,6 +402,9 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) { generator.writeKey("logstash"); this.logstash.serialize(generator, mapper); + generator.writeKey("logsdb"); + this.logsdb.serialize(generator, mapper); + generator.writeKey("ml"); this.ml.serialize(generator, mapper); @@ -476,6 +489,8 @@ public static class Builder extends WithJsonObjectBuilderBase implement private Feature logstash; + private Feature logsdb; + private Feature ml; private Feature monitoring; @@ -700,6 +715,21 @@ public final Builder logstash(Function> return this.logstash(fn.apply(new Feature.Builder()).build()); } + /** + * Required - API name: {@code logsdb} + */ + public final Builder logsdb(Feature value) { + this.logsdb = value; + return this; + } + + /** + * Required - API name: {@code logsdb} + */ + public final Builder logsdb(Function> fn) { + return this.logsdb(fn.apply(new Feature.Builder()).build()); + } + /** * Required - API name: {@code ml} */ @@ -951,6 +981,7 @@ protected static void setupFeaturesDeserializer(ObjectDeserializer