From 7b4d59f65ff750587d8a3ada5c4e833c4da431a0 Mon Sep 17 00:00:00 2001 From: Laura Trotta Date: Tue, 2 Dec 2025 12:01:39 +0000 Subject: [PATCH 1/2] [codegen] update to latest spec --- .../ElasticsearchAsyncClient.java | 304 ++++-- .../elasticsearch/ElasticsearchClient.java | 307 ++++-- .../async_search/AsyncSearchResponseBase.java | 38 + .../ccr/ElasticsearchCcrAsyncClient.java | 82 +- .../ccr/ElasticsearchCcrClient.java | 82 +- .../elasticsearch/ccr/FollowRequest.java | 10 +- .../ccr/ForgetFollowerRequest.java | 6 +- .../ccr/PutAutoFollowPatternRequest.java | 13 +- .../ccr/ResumeFollowRequest.java | 12 +- .../cluster/AllocationExplainRequest.java | 22 +- .../cluster/ClusterInfoRequest.java | 4 +- .../cluster/ClusterStatsRequest.java | 8 +- .../DeleteComponentTemplateRequest.java | 7 +- .../DeleteVotingConfigExclusionsRequest.java | 5 +- .../ElasticsearchClusterAsyncClient.java | 292 +++--- .../cluster/ElasticsearchClusterClient.java | 292 +++--- .../ExistsComponentTemplateRequest.java | 5 +- .../cluster/GetComponentTemplateRequest.java | 4 +- .../cluster/PendingTasksRequest.java | 7 +- .../PostVotingConfigExclusionsRequest.java | 21 +- .../cluster/PutComponentTemplateRequest.java | 7 +- .../elasticsearch/cluster/RerouteRequest.java | 10 +- .../elasticsearch/cluster/StateRequest.java | 5 +- .../ElasticsearchConnectorAsyncClient.java | 84 +- .../ElasticsearchConnectorClient.java | 84 +- .../connector/SyncJobCheckInRequest.java | 7 +- .../connector/SyncJobClaimRequest.java | 10 +- .../connector/SyncJobErrorRequest.java | 6 +- .../connector/SyncJobUpdateStatsRequest.java | 12 +- .../connector/UpdateFeaturesRequest.java | 7 +- .../elasticsearch/core/BulkRequest.java | 11 +- .../core/ClearScrollRequest.java | 5 +- .../core/ClosePointInTimeRequest.java | 14 +- .../elasticsearch/core/CountRequest.java | 4 +- .../core/DeleteByQueryRethrottleRequest.java | 23 +- .../core/DeleteScriptRequest.java | 5 +- .../elasticsearch/core/ExplainRequest.java | 7 +- .../elasticsearch/core/GetScriptRequest.java | 5 +- .../core/HealthReportRequest.java | 7 +- .../elasticsearch/core/InfoRequest.java | 8 +- .../elasticsearch/core/KnnSearchRequest.java | 649 +++++++++++++ .../elasticsearch/core/KnnSearchResponse.java | 394 ++++++++ .../elasticsearch/core/PingRequest.java | 4 +- .../elasticsearch/core/PutScriptRequest.java | 5 +- .../core/ReindexRethrottleRequest.java | 23 +- .../core/UpdateByQueryRequest.java | 9 +- .../core/UpdateByQueryRethrottleRequest.java | 23 +- .../core/knn_search/KnnSearchQuery.java | 267 ++++++ .../DeleteDanglingIndexRequest.java | 31 +- ...asticsearchDanglingIndicesAsyncClient.java | 16 +- .../ElasticsearchDanglingIndicesClient.java | 16 +- .../ImportDanglingIndexRequest.java | 23 +- .../elasticsearch/doc-files/api-spec.html | 625 ++++++------- .../enrich/DeletePolicyRequest.java | 5 +- .../ElasticsearchEnrichAsyncClient.java | 56 +- .../enrich/ElasticsearchEnrichClient.java | 56 +- .../enrich/EnrichStatsRequest.java | 6 +- .../enrich/ExecutePolicyRequest.java | 4 +- .../enrich/GetPolicyRequest.java | 4 +- .../enrich/PutPolicyRequest.java | 4 +- .../eql/ElasticsearchEqlAsyncClient.java | 76 +- .../eql/ElasticsearchEqlClient.java | 76 +- .../elasticsearch/eql/EqlDeleteRequest.java | 6 +- .../elasticsearch/eql/EqlGetRequest.java | 6 +- .../elasticsearch/eql/EqlSearchRequest.java | 17 +- .../eql/GetEqlStatusRequest.java | 6 +- .../esql/ElasticsearchEsqlAsyncClient.java | 26 +- .../esql/ElasticsearchEsqlClient.java | 26 +- .../elasticsearch/esql/GetQueryRequest.java | 5 +- .../esql/ListQueriesRequest.java | 6 +- .../elasticsearch/esql/QueryRequest.java | 5 +- .../ElasticsearchFeaturesAsyncClient.java | 57 +- .../features/ElasticsearchFeaturesClient.java | 57 +- .../features/GetFeaturesRequest.java | 12 +- .../features/ResetFeaturesRequest.java | 7 +- .../fleet/ElasticsearchFleetAsyncClient.java | 32 +- .../fleet/ElasticsearchFleetClient.java | 32 +- .../fleet/FleetSearchRequest.java | 8 +- .../graph/ElasticsearchGraphAsyncClient.java | 36 +- .../graph/ElasticsearchGraphClient.java | 36 +- .../elasticsearch/graph/ExploreRequest.java | 18 +- .../ilm/DeleteLifecycleRequest.java | 7 +- .../ilm/ElasticsearchIlmAsyncClient.java | 176 ++-- .../ilm/ElasticsearchIlmClient.java | 176 ++-- .../ilm/ExplainLifecycleRequest.java | 8 +- .../ilm/MigrateToDataTiersRequest.java | 12 +- .../elasticsearch/ilm/MoveToStepRequest.java | 6 +- .../ilm/PutLifecycleRequest.java | 6 +- .../ilm/RemovePolicyRequest.java | 6 +- .../elasticsearch/ilm/RetryRequest.java | 10 +- .../elasticsearch/ilm/StartIlmRequest.java | 9 +- .../elasticsearch/ilm/StopIlmRequest.java | 9 +- .../elasticsearch/indices/AnalyzeRequest.java | 6 +- .../indices/ClearCacheRequest.java | 6 +- .../indices/CloneIndexRequest.java | 6 +- .../indices/CloseIndexRequest.java | 12 +- .../indices/CreateIndexRequest.java | 6 +- .../indices/DeleteAliasRequest.java | 4 +- .../indices/DeleteDataLifecycleRequest.java | 6 +- .../DeleteDataStreamOptionsRequest.java | 5 +- .../indices/DeleteDataStreamRequest.java | 5 +- .../indices/DeleteIndexRequest.java | 8 +- .../indices/DeleteIndexTemplateRequest.java | 10 +- .../indices/DeleteTemplateRequest.java | 8 +- .../indices/DiskUsageRequest.java | 10 +- .../indices/DownsampleRequest.java | 16 +- .../ElasticsearchIndicesAsyncClient.java | 873 +++++++++++------- .../indices/ElasticsearchIndicesClient.java | 873 +++++++++++------- .../elasticsearch/indices/ExistsRequest.java | 5 +- .../indices/ExistsTemplateRequest.java | 8 +- .../indices/ExplainDataLifecycleRequest.java | 16 +- .../indices/FieldUsageStatsRequest.java | 11 +- .../elasticsearch/indices/FlushRequest.java | 18 +- .../indices/ForcemergeRequest.java | 8 +- .../indices/GetAliasRequest.java | 5 +- .../indices/GetDataLifecycleStatsRequest.java | 6 +- .../indices/GetFieldMappingRequest.java | 7 +- .../indices/GetIndexRequest.java | 6 +- .../indices/GetIndexTemplateRequest.java | 4 +- .../indices/GetIndicesSettingsRequest.java | 6 +- .../indices/GetMappingRequest.java | 6 +- .../indices/GetTemplateRequest.java | 5 +- .../indices/IndicesStatsRequest.java | 6 +- .../indices/MigrateToDataStreamRequest.java | 20 +- .../indices/ModifyDataStreamRequest.java | 6 +- .../elasticsearch/indices/OpenRequest.java | 5 +- .../indices/PromoteDataStreamRequest.java | 6 +- .../indices/PutAliasRequest.java | 4 +- .../indices/PutDataLifecycleRequest.java | 5 +- .../indices/PutDataStreamOptionsRequest.java | 5 +- .../indices/PutIndexTemplateRequest.java | 6 +- .../indices/PutIndicesSettingsRequest.java | 6 +- .../indices/PutMappingRequest.java | 6 +- .../indices/PutTemplateRequest.java | 9 +- .../indices/RecoveryRequest.java | 8 +- .../elasticsearch/indices/RefreshRequest.java | 8 +- .../indices/ReloadSearchAnalyzersRequest.java | 7 +- .../indices/ResolveIndexRequest.java | 7 +- .../indices/RolloverRequest.java | 9 +- .../indices/SegmentsRequest.java | 7 +- .../indices/ShardStoresRequest.java | 8 +- .../elasticsearch/indices/ShrinkRequest.java | 4 +- .../indices/SimulateIndexTemplateRequest.java | 6 +- .../indices/SimulateTemplateRequest.java | 6 +- .../elasticsearch/indices/SplitRequest.java | 4 +- .../indices/UpdateAliasesRequest.java | 4 +- .../indices/ValidateQueryRequest.java | 4 +- .../ChatCompletionUnifiedRequest.java | 2 +- .../inference/CompletionRequest.java | 10 +- .../inference/DeleteInferenceRequest.java | 17 +- .../ElasticsearchInferenceAsyncClient.java | 77 +- .../ElasticsearchInferenceClient.java | 77 +- .../inference/GetInferenceRequest.java | 9 +- .../inference/PutAnthropicRequest.java | 6 +- .../inference/PutAzureaistudioRequest.java | 6 +- .../inference/RequestChatCompletion.java | 6 +- .../inference/RerankRequest.java | 2 +- .../inference/SparseEmbeddingRequest.java | 10 +- .../inference/StreamCompletionRequest.java | 16 +- .../inference/TextEmbeddingRequest.java | 10 +- .../ingest/DeletePipelineRequest.java | 4 +- .../ElasticsearchIngestAsyncClient.java | 35 +- .../ingest/ElasticsearchIngestClient.java | 35 +- .../ingest/GeoIpStatsRequest.java | 6 +- .../ingest/ProcessorGrokRequest.java | 11 +- .../ingest/PutPipelineRequest.java | 5 +- .../ElasticsearchLicenseAsyncClient.java | 15 +- .../license/ElasticsearchLicenseClient.java | 15 +- .../license/PostStartTrialRequest.java | 5 +- .../logstash/DeletePipelineRequest.java | 8 +- .../ElasticsearchLogstashAsyncClient.java | 31 +- .../logstash/ElasticsearchLogstashClient.java | 31 +- .../logstash/GetPipelineRequest.java | 5 +- .../migration/DeprecationsRequest.java | 8 +- .../ElasticsearchMigrationAsyncClient.java | 41 +- .../ElasticsearchMigrationClient.java | 41 +- .../GetFeatureUpgradeStatusRequest.java | 9 +- .../migration/PostFeatureUpgradeRequest.java | 8 +- .../ml/ElasticsearchMlAsyncClient.java | 819 +++++++++------- .../ml/ElasticsearchMlClient.java | 819 +++++++++------- .../elasticsearch/ml/FlushJobRequest.java | 18 +- .../elasticsearch/ml/GetBucketsRequest.java | 5 +- .../ml/GetDataFrameAnalyticsRequest.java | 8 +- .../ml/GetDatafeedStatsRequest.java | 11 +- .../elasticsearch/ml/GetDatafeedsRequest.java | 11 +- .../elasticsearch/ml/GetFiltersRequest.java | 4 +- .../ml/GetInfluencersRequest.java | 7 +- .../elasticsearch/ml/GetJobsRequest.java | 13 +- .../ml/GetMemoryStatsRequest.java | 8 +- .../elasticsearch/ml/GetRecordsRequest.java | 20 +- .../ml/GetTrainedModelsStatsRequest.java | 8 +- .../elasticsearch/ml/MlInfoRequest.java | 15 +- .../ml/PreviewDataFrameAnalyticsRequest.java | 5 +- .../ml/PreviewDatafeedRequest.java | 22 +- .../ml/PutDataFrameAnalyticsRequest.java | 10 +- .../elasticsearch/ml/PutDatafeedRequest.java | 12 +- .../elasticsearch/ml/PutFilterRequest.java | 6 +- .../ml/PutTrainedModelAliasRequest.java | 28 +- .../ml/PutTrainedModelRequest.java | 6 +- .../ml/PutTrainedModelVocabularyRequest.java | 9 +- .../elasticsearch/ml/ResetJobRequest.java | 9 +- .../ml/RevertModelSnapshotRequest.java | 17 +- .../ml/SetUpgradeModeRequest.java | 24 +- .../ml/StartDataFrameAnalyticsRequest.java | 10 +- .../StartTrainedModelDeploymentRequest.java | 5 +- .../ml/StopDataFrameAnalyticsRequest.java | 6 +- .../elasticsearch/ml/StopDatafeedRequest.java | 7 +- .../ml/UpdateDatafeedRequest.java | 12 +- .../elasticsearch/ml/UpdateFilterRequest.java | 6 +- .../elasticsearch/ml/UpdateJobRequest.java | 5 +- .../ml/UpdateModelSnapshotRequest.java | 4 +- .../ml/UpgradeJobSnapshotRequest.java | 18 +- .../elasticsearch/monitoring/BulkRequest.java | 77 +- .../ElasticsearchMonitoringAsyncClient.java | 10 +- .../ElasticsearchMonitoringClient.java | 10 +- ...earRepositoriesMeteringArchiveRequest.java | 5 +- .../nodes/ElasticsearchNodesAsyncClient.java | 75 +- .../nodes/ElasticsearchNodesClient.java | 75 +- .../GetRepositoriesMeteringInfoRequest.java | 13 +- .../nodes/HotThreadsRequest.java | 7 +- .../nodes/NodesStatsRequest.java | 6 +- .../ElasticsearchProjectAsyncClient.java | 4 +- .../project/ElasticsearchProjectClient.java | 4 +- .../elasticsearch/project/TagsRequest.java | 4 +- .../query_rules/DeleteRuleRequest.java | 8 +- .../query_rules/DeleteRulesetRequest.java | 6 +- .../ElasticsearchQueryRulesAsyncClient.java | 94 +- .../ElasticsearchQueryRulesClient.java | 94 +- .../query_rules/GetRuleRequest.java | 4 +- .../query_rules/GetRulesetRequest.java | 4 +- .../query_rules/ListRulesetsRequest.java | 4 +- .../query_rules/PutRuleRequest.java | 5 +- .../query_rules/PutRulesetRequest.java | 8 +- .../query_rules/TestRequest.java | 6 +- .../ElasticsearchRollupAsyncClient.java | 127 ++- .../rollup/ElasticsearchRollupClient.java | 127 ++- .../elasticsearch/rollup/GetJobsRequest.java | 5 +- .../rollup/GetRollupCapsRequest.java | 6 +- .../rollup/GetRollupIndexCapsRequest.java | 10 +- .../rollup/RollupSearchRequest.java | 12 +- .../elasticsearch/rollup/StartJobRequest.java | 7 +- .../elasticsearch/rollup/StopJobRequest.java | 6 +- .../DeleteBehavioralAnalyticsRequest.java | 5 +- ...ticsearchSearchApplicationAsyncClient.java | 92 +- .../ElasticsearchSearchApplicationClient.java | 92 +- .../search_application/ListRequest.java | 4 +- .../RenderQueryRequest.java | 15 +- .../SearchApplicationSearchRequest.java | 10 +- .../CacheStatsRequest.java | 5 +- .../ClearCacheRequest.java | 6 +- ...csearchSearchableSnapshotsAsyncClient.java | 49 +- ...lasticsearchSearchableSnapshotsClient.java | 49 +- .../searchable_snapshots/MountRequest.java | 8 +- .../security/BulkUpdateApiKeysRequest.java | 4 +- .../ElasticsearchSecurityAsyncClient.java | 8 +- .../security/ElasticsearchSecurityClient.java | 8 +- .../shutdown/DeleteNodeRequest.java | 10 +- .../ElasticsearchShutdownAsyncClient.java | 20 +- .../shutdown/ElasticsearchShutdownClient.java | 20 +- .../shutdown/GetNodeRequest.java | 6 +- .../ElasticsearchSimulateAsyncClient.java | 14 +- .../simulate/ElasticsearchSimulateClient.java | 14 +- .../elasticsearch/simulate/IngestRequest.java | 7 +- .../slm/DeleteLifecycleRequest.java | 8 +- .../slm/ElasticsearchSlmAsyncClient.java | 181 ++-- .../slm/ElasticsearchSlmClient.java | 181 ++-- .../slm/ExecuteLifecycleRequest.java | 10 +- .../slm/ExecuteRetentionRequest.java | 9 +- .../slm/GetLifecycleRequest.java | 6 +- .../elasticsearch/slm/GetStatsRequest.java | 6 +- .../slm/PutLifecycleRequest.java | 8 +- .../elasticsearch/slm/StartSlmRequest.java | 8 +- .../elasticsearch/slm/StopSlmRequest.java | 14 +- .../snapshot/CleanupRepositoryRequest.java | 7 +- .../snapshot/CloneSnapshotRequest.java | 5 +- .../snapshot/CreateRepositoryRequest.java | 10 +- .../snapshot/CreateSnapshotRequest.java | 5 +- .../snapshot/DeleteRepositoryRequest.java | 9 +- .../ElasticsearchSnapshotAsyncClient.java | 120 ++- .../snapshot/ElasticsearchSnapshotClient.java | 120 ++- .../RepositoryVerifyIntegrityRequest.java | 5 +- .../snapshot/RestoreRequest.java | 5 +- .../snapshot/SnapshotStatusRequest.java | 6 +- .../snapshot/VerifyRepositoryRequest.java | 5 +- .../elasticsearch/sql/DeleteAsyncRequest.java | 6 +- .../sql/ElasticsearchSqlAsyncClient.java | 64 +- .../sql/ElasticsearchSqlClient.java | 64 +- .../elasticsearch/sql/GetAsyncRequest.java | 6 +- .../sql/GetAsyncStatusRequest.java | 6 +- .../elasticsearch/sql/QueryRequest.java | 4 +- .../elasticsearch/sql/TranslateRequest.java | 8 +- .../synonyms/DeleteSynonymRuleRequest.java | 4 +- .../ElasticsearchSynonymsAsyncClient.java | 52 +- .../synonyms/ElasticsearchSynonymsClient.java | 52 +- .../synonyms/GetSynonymRuleRequest.java | 4 +- .../synonyms/GetSynonymsSetsRequest.java | 4 +- .../synonyms/PutSynonymRequest.java | 7 +- .../synonyms/PutSynonymRuleRequest.java | 5 +- .../tasks/ElasticsearchTasksAsyncClient.java | 28 +- .../tasks/ElasticsearchTasksClient.java | 28 +- .../elasticsearch/tasks/GetTasksRequest.java | 5 +- .../elasticsearch/tasks/ListRequest.java | 6 +- ...ElasticsearchTextStructureAsyncClient.java | 40 +- .../ElasticsearchTextStructureClient.java | 40 +- .../FindFieldStructureRequest.java | 5 +- .../FindMessageStructureRequest.java | 7 +- .../TestGrokPatternRequest.java | 8 +- .../ElasticsearchTransformAsyncClient.java | 132 ++- .../ElasticsearchTransformClient.java | 132 ++- .../transform/GetTransformRequest.java | 4 +- .../transform/PreviewTransformRequest.java | 6 +- .../transform/PutTransformRequest.java | 4 +- .../transform/SetUpgradeModeRequest.java | 24 +- .../transform/StopTransformRequest.java | 4 +- .../transform/UpdateTransformRequest.java | 4 +- .../watcher/AckWatchRequest.java | 6 +- .../watcher/ActivateWatchRequest.java | 4 +- .../watcher/DeactivateWatchRequest.java | 4 +- .../watcher/DeleteWatchRequest.java | 7 +- .../ElasticsearchWatcherAsyncClient.java | 188 ++-- .../watcher/ElasticsearchWatcherClient.java | 188 ++-- .../watcher/ExecuteWatchRequest.java | 7 +- .../watcher/GetWatcherSettingsRequest.java | 6 +- .../watcher/PutWatchRequest.java | 10 +- .../watcher/QueryWatchesRequest.java | 6 +- .../watcher/StartWatcherRequest.java | 5 +- .../watcher/StopWatcherRequest.java | 4 +- .../watcher/UpdateSettingsRequest.java | 8 +- .../watcher/WatcherStatsRequest.java | 6 +- .../xpack/ElasticsearchXpackAsyncClient.java | 33 +- .../xpack/ElasticsearchXpackClient.java | 33 +- .../elasticsearch/xpack/XpackInfoRequest.java | 4 +- .../xpack/XpackUsageRequest.java | 7 +- 333 files changed, 8379 insertions(+), 4623 deletions(-) create mode 100644 java-client/src/main/java/co/elastic/clients/elasticsearch/core/KnnSearchRequest.java create mode 100644 java-client/src/main/java/co/elastic/clients/elasticsearch/core/KnnSearchResponse.java create mode 100644 java-client/src/main/java/co/elastic/clients/elasticsearch/core/knn_search/KnnSearchQuery.java 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 2d5fe918ef..55da3a7b1d 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 @@ -67,6 +67,8 @@ import co.elastic.clients.elasticsearch.core.IndexResponse; import co.elastic.clients.elasticsearch.core.InfoRequest; import co.elastic.clients.elasticsearch.core.InfoResponse; +import co.elastic.clients.elasticsearch.core.KnnSearchRequest; +import co.elastic.clients.elasticsearch.core.KnnSearchResponse; import co.elastic.clients.elasticsearch.core.MgetRequest; import co.elastic.clients.elasticsearch.core.MgetResponse; import co.elastic.clients.elasticsearch.core.MsearchRequest; @@ -383,10 +385,11 @@ public ElasticsearchXpackAsyncClient xpack() { // ----- Endpoint: bulk /** - * Bulk index or delete documents. Perform multiple index, - * create, delete, and update actions in - * a single request. This reduces overhead and can greatly increase indexing - * speed. + * Bulk index or delete documents. + *

+ * Perform multiple index, create, + * delete, and update actions in a single request. + * This reduces overhead and can greatly increase indexing speed. *

* If the Elasticsearch security features are enabled, you must have the * following index privileges for the target data stream, index, or index alias: @@ -483,6 +486,8 @@ public ElasticsearchXpackAsyncClient xpack() { * Search::Elasticsearch::Client::5_0::Scroll *

  • Python: Check out elasticsearch.helpers.*
    • *
  • JavaScript: Check out client.helpers.*
    • + *
  • Java: Check out + * co.elastic.clients.elasticsearch._helpers.bulk.BulkIngester
    • *
  • .NET: Check out BulkAllObservable
    • *
  • PHP: Check out bulk indexing.
    • *
  • Ruby: Check out Elasticsearch::Helpers::BulkHelper
    • @@ -562,10 +567,11 @@ public CompletableFuture bulk(BulkRequest request) { } /** - * Bulk index or delete documents. Perform multiple index, - * create, delete, and update actions in - * a single request. This reduces overhead and can greatly increase indexing - * speed. + * Bulk index or delete documents. + *

    + * Perform multiple index, create, + * delete, and update actions in a single request. + * This reduces overhead and can greatly increase indexing speed. *

    * If the Elasticsearch security features are enabled, you must have the * following index privileges for the target data stream, index, or index alias: @@ -662,6 +668,8 @@ public CompletableFuture bulk(BulkRequest request) { * Search::Elasticsearch::Client::5_0::Scroll *

  • Python: Check out elasticsearch.helpers.*
    • *
  • JavaScript: Check out client.helpers.*
    • + *
  • Java: Check out + * co.elastic.clients.elasticsearch._helpers.bulk.BulkIngester
    • *
  • .NET: Check out BulkAllObservable
    • *
  • PHP: Check out bulk indexing.
    • *
  • Ruby: Check out Elasticsearch::Helpers::BulkHelper
    • @@ -741,10 +749,11 @@ public final CompletableFuture bulk(Functionindex, - * create, delete, and update actions in - * a single request. This reduces overhead and can greatly increase indexing - * speed. + * Bulk index or delete documents. + *

    + * Perform multiple index, create, + * delete, and update actions in a single request. + * This reduces overhead and can greatly increase indexing speed. *

    * If the Elasticsearch security features are enabled, you must have the * following index privileges for the target data stream, index, or index alias: @@ -841,6 +850,8 @@ public final CompletableFuture bulk(FunctionSearch::Elasticsearch::Client::5_0::Scroll *

  • Python: Check out elasticsearch.helpers.*
    • *
  • JavaScript: Check out client.helpers.*
    • + *
  • Java: Check out + * co.elastic.clients.elasticsearch._helpers.bulk.BulkIngester
    • *
  • .NET: Check out BulkAllObservable
    • *
  • PHP: Check out bulk indexing.
    • *
  • Ruby: Check out Elasticsearch::Helpers::BulkHelper
    • @@ -920,8 +931,9 @@ public CompletableFuture bulk() { // ----- Endpoint: clear_scroll /** - * Clear a scrolling search. Clear 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 @@ -936,8 +948,9 @@ public CompletableFuture clearScroll(ClearScrollRequest req } /** - * Clear a scrolling search. Clear 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 @@ -953,8 +966,9 @@ public final CompletableFuture clearScroll( } /** - * Clear a scrolling search. Clear 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 @@ -969,12 +983,14 @@ public CompletableFuture clearScroll() { // ----- Endpoint: close_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. + * 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 @@ -989,12 +1005,14 @@ public CompletableFuture closePointInTime(ClosePointIn } /** - * 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. + * 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 @@ -1012,7 +1030,9 @@ public final CompletableFuture closePointInTime( // ----- Endpoint: count /** - * Count search results. Get the number of documents matching a query. + * Count search results. + *

    + * Get the number of documents matching a query. *

    * The query can be provided either by using a simple query string as a * parameter, or by defining Query DSL within the request body. The query is @@ -1039,7 +1059,9 @@ public CompletableFuture count(CountRequest request) { } /** - * Count search results. Get the number of documents matching a query. + * Count search results. + *

    + * Get the number of documents matching a query. *

    * The query can be provided either by using a simple query string as a * parameter, or by defining Query DSL within the request body. The query is @@ -1067,7 +1089,9 @@ public final CompletableFuture count( } /** - * Count search results. Get the number of documents matching a query. + * Count search results. + *

    + * Get the number of documents matching a query. *

    * The query can be provided either by using a simple query string as a * parameter, or by defining Query DSL within the request body. The query is @@ -1839,8 +1863,9 @@ public final CompletableFuture deleteByQueryRet // ----- Endpoint: delete_script /** - * Delete a script or search template. Deletes a stored script or search - * template. + * Delete a script or search template. + *

    + * Deletes a stored script or search template. * * @see Documentation @@ -1855,8 +1880,9 @@ public CompletableFuture deleteScript(DeleteScriptRequest } /** - * Delete a script or search template. Deletes a stored script or search - * template. + * Delete a script or search template. + *

    + * Deletes a stored script or search template. * * @param fn * a function that initializes a builder to create the @@ -2002,9 +2028,10 @@ public final CompletableFuture existsSource( // ----- Endpoint: explain /** - * Explain a document match result. Get information about why a specific - * document matches, or doesn't match, a query. It computes a score explanation - * for a query and a specific document. + * Explain a document match result. + *

    + * Get information about why a specific document matches, or doesn't match, a + * query. It computes a score explanation for a query and a specific document. * * @see Documentation @@ -2022,9 +2049,10 @@ public CompletableFuture> explain(Explain } /** - * Explain a document match result. Get information about why a specific - * document matches, or doesn't match, a query. It computes a score explanation - * for a query and a specific document. + * Explain a document match result. + *

    + * Get information about why a specific document matches, or doesn't match, a + * query. It computes a score explanation for a query and a specific document. * * @param fn * a function that initializes a builder to create the @@ -2061,9 +2089,10 @@ public final CompletableFuture> explain( } /** - * Explain a document match result. Get information about why a specific - * document matches, or doesn't match, a query. It computes a score explanation - * for a query and a specific document. + * Explain a document match result. + *

    + * Get information about why a specific document matches, or doesn't match, a + * query. It computes a score explanation for a query and a specific document. * * @see Documentation @@ -2081,9 +2110,10 @@ public CompletableFuture> explain(Explain } /** - * Explain a document match result. Get information about why a specific - * document matches, or doesn't match, a query. It computes a score explanation - * for a query and a specific document. + * Explain a document match result. + *

    + * Get information about why a specific document matches, or doesn't match, a + * query. It computes a score explanation for a query and a specific document. * * @param fn * a function that initializes a builder to create the @@ -2541,8 +2571,9 @@ public final CompletableFuture> get( // ----- Endpoint: get_script /** - * Get a script or search template. Retrieves a stored script or search - * template. + * Get a script or search template. + *

    + * Retrieves a stored script or search template. * * @see Documentation @@ -2557,8 +2588,9 @@ public CompletableFuture getScript(GetScriptRequest request) } /** - * Get a script or search template. Retrieves a stored script or search - * template. + * Get a script or search template. + *

    + * Retrieves a stored script or search template. * * @param fn * a function that initializes a builder to create the @@ -2761,9 +2793,10 @@ public final CompletableFuture> getSour // ----- Endpoint: health_report /** - * Get the cluster health. Get a report with the health status of an - * Elasticsearch cluster. The report contains a list of indicators that compose - * Elasticsearch functionality. + * Get the cluster health. + *

    + * Get a report with the health status of an Elasticsearch cluster. The report + * contains a list of indicators that compose Elasticsearch functionality. *

    * Each indicator has a health status of: green, unknown, yellow or red. The * indicator will provide an explanation and metadata describing the reason for @@ -2803,9 +2836,10 @@ public CompletableFuture healthReport(HealthReportRequest } /** - * Get the cluster health. Get a report with the health status of an - * Elasticsearch cluster. The report contains a list of indicators that compose - * Elasticsearch functionality. + * Get the cluster health. + *

    + * Get a report with the health status of an Elasticsearch cluster. The report + * contains a list of indicators that compose Elasticsearch functionality. *

    * Each indicator has a health status of: green, unknown, yellow or red. The * indicator will provide an explanation and metadata describing the reason for @@ -2846,9 +2880,10 @@ public final CompletableFuture healthReport( } /** - * Get the cluster health. Get a report with the health status of an - * Elasticsearch cluster. The report contains a list of indicators that compose - * Elasticsearch functionality. + * Get the cluster health. + *

    + * Get a report with the health status of an Elasticsearch cluster. The report + * contains a list of indicators that compose Elasticsearch functionality. *

    * Each indicator has a health status of: green, unknown, yellow or red. The * indicator will provide an explanation and metadata describing the reason for @@ -3297,9 +3332,11 @@ public final CompletableFuture index( // ----- Endpoint: info /** - * Get cluster info. Get basic build, version, and cluster information. ::: In - * Serverless, this API is retained for backward compatibility only. Some - * response fields, such as the version number, should be ignored. + * Get cluster info. + *

    + * Get basic build, version, and cluster information. ::: In Serverless, this + * API is retained for backward compatibility only. Some response fields, such + * as the version number, should be ignored. * * @see Documentation @@ -3309,6 +3346,111 @@ public CompletableFuture info() { return this.transport.performRequestAsync(InfoRequest._INSTANCE, InfoRequest._ENDPOINT, this.transportOptions); } + // ----- Endpoint: knn_search + + /** + * Run a knn search. + *

    + * NOTE: The kNN search API has been replaced by the knn option in + * the search API. + * + * @see Documentation + * on elastic.co + */ + + public CompletableFuture> knnSearch(KnnSearchRequest request, + Class tDocumentClass) { + @SuppressWarnings("unchecked") + JsonEndpoint, ErrorResponse> endpoint = (JsonEndpoint, ErrorResponse>) KnnSearchRequest._ENDPOINT; + endpoint = new EndpointWithResponseMapperAttr<>(endpoint, + "co.elastic.clients:Deserializer:_global.knn_search.Response.TDocument", + getDeserializer(tDocumentClass)); + + return this.transport.performRequestAsync(request, endpoint, this.transportOptions); + } + + /** + * Run a knn search. + *

    + * NOTE: The kNN search API has been replaced by the knn option in + * the search API. + * + * @param fn + * a function that initializes a builder to create the + * {@link KnnSearchRequest} + * @see Documentation + * on elastic.co + */ + + public final CompletableFuture> knnSearch( + Function> fn, Class tDocumentClass) { + return knnSearch(fn.apply(new KnnSearchRequest.Builder()).build(), tDocumentClass); + } + + /** + * Overload of {@link #knnSearch(KnnSearchRequest, Class)}, where Class is + * defined as Void, meaning the documents will not be deserialized. + */ + + public CompletableFuture> knnSearch(KnnSearchRequest request) { + @SuppressWarnings("unchecked") + JsonEndpoint, ErrorResponse> endpoint = (JsonEndpoint, ErrorResponse>) KnnSearchRequest._ENDPOINT; + return this.transport.performRequestAsync(request, endpoint, this.transportOptions); + } + + /** + * Overload of {@link #knnSearch(Function, Class)}, where Class is defined as + * Void, meaning the documents will not be deserialized. + */ + + public final CompletableFuture> knnSearch( + Function> fn) { + return knnSearch(fn.apply(new KnnSearchRequest.Builder()).build(), Void.class); + } + + /** + * Run a knn search. + *

    + * NOTE: The kNN search API has been replaced by the knn option in + * the search API. + * + * @see Documentation + * on elastic.co + */ + + public CompletableFuture> knnSearch(KnnSearchRequest request, + Type tDocumentType) { + @SuppressWarnings("unchecked") + JsonEndpoint, ErrorResponse> endpoint = (JsonEndpoint, ErrorResponse>) KnnSearchRequest._ENDPOINT; + endpoint = new EndpointWithResponseMapperAttr<>(endpoint, + "co.elastic.clients:Deserializer:_global.knn_search.Response.TDocument", + getDeserializer(tDocumentType)); + + return this.transport.performRequestAsync(request, endpoint, this.transportOptions); + } + + /** + * Run a knn search. + *

    + * NOTE: The kNN search API has been replaced by the knn option in + * the search API. + * + * @param fn + * a function that initializes a builder to create the + * {@link KnnSearchRequest} + * @see Documentation + * on elastic.co + */ + + public final CompletableFuture> knnSearch( + Function> fn, Type tDocumentType) { + return knnSearch(fn.apply(new KnnSearchRequest.Builder()).build(), tDocumentType); + } + // ----- Endpoint: mget /** @@ -4048,7 +4190,9 @@ public final CompletableFuture openPointInTime( // ----- Endpoint: ping /** - * Ping the cluster. Get information about whether the cluster is running. + * Ping the cluster. + *

    + * Get information about whether the cluster is running. * * @see Documentation @@ -4061,8 +4205,9 @@ public CompletableFuture ping() { // ----- Endpoint: put_script /** - * Create or update a script or search template. Creates or updates a stored - * script or search template. + * Create or update a script or search template. + *

    + * Creates or updates a stored script or search template. * * @see Documentation @@ -4077,8 +4222,9 @@ public CompletableFuture putScript(PutScriptRequest request) } /** - * Create or update a script or search template. Creates or updates a stored - * script or search template. + * Create or update a script or search template. + *

    + * Creates or updates a stored script or search template. * * @param fn * a function that initializes a builder to create the @@ -6140,10 +6286,11 @@ public final CompletableFuture + * Updates documents that match the specified query. If no query is specified, + * performs an update on every document in the data stream or index without + * modifying the source, which is useful for picking up mapping changes. *

    * If the Elasticsearch security features are enabled, you must have the * following index privileges for the target data stream, index, or alias: @@ -6301,10 +6448,11 @@ public CompletableFuture updateByQuery(UpdateByQueryReque } /** - * Update documents. Updates documents that match the specified query. If no - * query is specified, performs an update on every document in the data stream - * or index without modifying the source, which is useful for picking up mapping - * changes. + * Update documents. + *

    + * Updates documents that match the specified query. If no query is specified, + * performs an update on every document in the data stream or index without + * modifying the source, which is useful for picking up mapping changes. *

    * If the Elasticsearch security features are enabled, you must have the * following index privileges for the target data stream, index, or alias: 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 fa0bc36ac5..59d9218511 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 @@ -68,6 +68,8 @@ import co.elastic.clients.elasticsearch.core.IndexResponse; import co.elastic.clients.elasticsearch.core.InfoRequest; import co.elastic.clients.elasticsearch.core.InfoResponse; +import co.elastic.clients.elasticsearch.core.KnnSearchRequest; +import co.elastic.clients.elasticsearch.core.KnnSearchResponse; import co.elastic.clients.elasticsearch.core.MgetRequest; import co.elastic.clients.elasticsearch.core.MgetResponse; import co.elastic.clients.elasticsearch.core.MsearchRequest; @@ -383,10 +385,11 @@ public ElasticsearchXpackClient xpack() { // ----- Endpoint: bulk /** - * Bulk index or delete documents. Perform multiple index, - * create, delete, and update actions in - * a single request. This reduces overhead and can greatly increase indexing - * speed. + * Bulk index or delete documents. + *

    + * Perform multiple index, create, + * delete, and update actions in a single request. + * This reduces overhead and can greatly increase indexing speed. *

    * If the Elasticsearch security features are enabled, you must have the * following index privileges for the target data stream, index, or index alias: @@ -483,6 +486,8 @@ public ElasticsearchXpackClient xpack() { * Search::Elasticsearch::Client::5_0::Scroll *

  • Python: Check out elasticsearch.helpers.*
    • *
  • JavaScript: Check out client.helpers.*
    • + *
  • Java: Check out + * co.elastic.clients.elasticsearch._helpers.bulk.BulkIngester
    • *
  • .NET: Check out BulkAllObservable
    • *
  • PHP: Check out bulk indexing.
    • *
  • Ruby: Check out Elasticsearch::Helpers::BulkHelper
    • @@ -562,10 +567,11 @@ public BulkResponse bulk(BulkRequest request) throws IOException, ElasticsearchE } /** - * Bulk index or delete documents. Perform multiple index, - * create, delete, and update actions in - * a single request. This reduces overhead and can greatly increase indexing - * speed. + * Bulk index or delete documents. + *

    + * Perform multiple index, create, + * delete, and update actions in a single request. + * This reduces overhead and can greatly increase indexing speed. *

    * If the Elasticsearch security features are enabled, you must have the * following index privileges for the target data stream, index, or index alias: @@ -662,6 +668,8 @@ public BulkResponse bulk(BulkRequest request) throws IOException, ElasticsearchE * Search::Elasticsearch::Client::5_0::Scroll *

  • Python: Check out elasticsearch.helpers.*
    • *
  • JavaScript: Check out client.helpers.*
    • + *
  • Java: Check out + * co.elastic.clients.elasticsearch._helpers.bulk.BulkIngester
    • *
  • .NET: Check out BulkAllObservable
    • *
  • PHP: Check out bulk indexing.
    • *
  • Ruby: Check out Elasticsearch::Helpers::BulkHelper
    • @@ -742,10 +750,11 @@ public final BulkResponse bulk(Functionindex, - * create, delete, and update actions in - * a single request. This reduces overhead and can greatly increase indexing - * speed. + * Bulk index or delete documents. + *

    + * Perform multiple index, create, + * delete, and update actions in a single request. + * This reduces overhead and can greatly increase indexing speed. *

    * If the Elasticsearch security features are enabled, you must have the * following index privileges for the target data stream, index, or index alias: @@ -842,6 +851,8 @@ public final BulkResponse bulk(FunctionSearch::Elasticsearch::Client::5_0::Scroll *

  • Python: Check out elasticsearch.helpers.*
    • *
  • JavaScript: Check out client.helpers.*
    • + *
  • Java: Check out + * co.elastic.clients.elasticsearch._helpers.bulk.BulkIngester
    • *
  • .NET: Check out BulkAllObservable
    • *
  • PHP: Check out bulk indexing.
    • *
  • Ruby: Check out Elasticsearch::Helpers::BulkHelper
    • @@ -921,8 +932,9 @@ public BulkResponse bulk() throws IOException, ElasticsearchException { // ----- Endpoint: clear_scroll /** - * Clear a scrolling search. Clear 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 @@ -937,8 +949,9 @@ public ClearScrollResponse clearScroll(ClearScrollRequest request) throws IOExce } /** - * Clear a scrolling search. Clear 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 @@ -955,8 +968,9 @@ public final ClearScrollResponse clearScroll( } /** - * Clear a scrolling search. Clear 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 @@ -971,12 +985,14 @@ public ClearScrollResponse clearScroll() throws IOException, ElasticsearchExcept // ----- Endpoint: close_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. + * 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 @@ -992,12 +1008,14 @@ public ClosePointInTimeResponse closePointInTime(ClosePointInTimeRequest request } /** - * 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. + * 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 @@ -1016,7 +1034,9 @@ public final ClosePointInTimeResponse closePointInTime( // ----- Endpoint: count /** - * Count search results. Get the number of documents matching a query. + * Count search results. + *

    + * Get the number of documents matching a query. *

    * The query can be provided either by using a simple query string as a * parameter, or by defining Query DSL within the request body. The query is @@ -1043,7 +1063,9 @@ public CountResponse count(CountRequest request) throws IOException, Elasticsear } /** - * Count search results. Get the number of documents matching a query. + * Count search results. + *

    + * Get the number of documents matching a query. *

    * The query can be provided either by using a simple query string as a * parameter, or by defining Query DSL within the request body. The query is @@ -1071,7 +1093,9 @@ public final CountResponse count(Function + * Get the number of documents matching a query. *

    * The query can be provided either by using a simple query string as a * parameter, or by defining Query DSL within the request body. The query is @@ -1848,8 +1872,9 @@ public final DeleteByQueryRethrottleResponse deleteByQueryRethrottle( // ----- Endpoint: delete_script /** - * Delete a script or search template. Deletes a stored script or search - * template. + * Delete a script or search template. + *

    + * Deletes a stored script or search template. * * @see Documentation @@ -1864,8 +1889,9 @@ public DeleteScriptResponse deleteScript(DeleteScriptRequest request) throws IOE } /** - * Delete a script or search template. Deletes a stored script or search - * template. + * Delete a script or search template. + *

    + * Deletes a stored script or search template. * * @param fn * a function that initializes a builder to create the @@ -2013,9 +2039,10 @@ public final BooleanResponse existsSource( // ----- Endpoint: explain /** - * Explain a document match result. Get information about why a specific - * document matches, or doesn't match, a query. It computes a score explanation - * for a query and a specific document. + * Explain a document match result. + *

    + * Get information about why a specific document matches, or doesn't match, a + * query. It computes a score explanation for a query and a specific document. * * @see Documentation @@ -2033,9 +2060,10 @@ public ExplainResponse explain(ExplainRequest request, Cl } /** - * Explain a document match result. Get information about why a specific - * document matches, or doesn't match, a query. It computes a score explanation - * for a query and a specific document. + * Explain a document match result. + *

    + * Get information about why a specific document matches, or doesn't match, a + * query. It computes a score explanation for a query and a specific document. * * @param fn * a function that initializes a builder to create the @@ -2073,9 +2101,10 @@ public final ExplainResponse explain(Function + * Get information about why a specific document matches, or doesn't match, a + * query. It computes a score explanation for a query and a specific document. * * @see Documentation @@ -2093,9 +2122,10 @@ public ExplainResponse explain(ExplainRequest request, Ty } /** - * Explain a document match result. Get information about why a specific - * document matches, or doesn't match, a query. It computes a score explanation - * for a query and a specific document. + * Explain a document match result. + *

    + * Get information about why a specific document matches, or doesn't match, a + * query. It computes a score explanation for a query and a specific document. * * @param fn * a function that initializes a builder to create the @@ -2556,8 +2586,9 @@ public final GetResponse get(Function + * Retrieves a stored script or search template. * * @see Documentation @@ -2572,8 +2603,9 @@ public GetScriptResponse getScript(GetScriptRequest request) throws IOException, } /** - * Get a script or search template. Retrieves a stored script or search - * template. + * Get a script or search template. + *

    + * Retrieves a stored script or search template. * * @param fn * a function that initializes a builder to create the @@ -2779,9 +2811,10 @@ public final GetSourceResponse getSource( // ----- Endpoint: health_report /** - * Get the cluster health. Get a report with the health status of an - * Elasticsearch cluster. The report contains a list of indicators that compose - * Elasticsearch functionality. + * Get the cluster health. + *

    + * Get a report with the health status of an Elasticsearch cluster. The report + * contains a list of indicators that compose Elasticsearch functionality. *

    * Each indicator has a health status of: green, unknown, yellow or red. The * indicator will provide an explanation and metadata describing the reason for @@ -2821,9 +2854,10 @@ public HealthReportResponse healthReport(HealthReportRequest request) throws IOE } /** - * Get the cluster health. Get a report with the health status of an - * Elasticsearch cluster. The report contains a list of indicators that compose - * Elasticsearch functionality. + * Get the cluster health. + *

    + * Get a report with the health status of an Elasticsearch cluster. The report + * contains a list of indicators that compose Elasticsearch functionality. *

    * Each indicator has a health status of: green, unknown, yellow or red. The * indicator will provide an explanation and metadata describing the reason for @@ -2865,9 +2899,10 @@ public final HealthReportResponse healthReport( } /** - * Get the cluster health. Get a report with the health status of an - * Elasticsearch cluster. The report contains a list of indicators that compose - * Elasticsearch functionality. + * Get the cluster health. + *

    + * Get a report with the health status of an Elasticsearch cluster. The report + * contains a list of indicators that compose Elasticsearch functionality. *

    * Each indicator has a health status of: green, unknown, yellow or red. The * indicator will provide an explanation and metadata describing the reason for @@ -3317,9 +3352,11 @@ public final IndexResponse index( // ----- Endpoint: info /** - * Get cluster info. Get basic build, version, and cluster information. ::: In - * Serverless, this API is retained for backward compatibility only. Some - * response fields, such as the version number, should be ignored. + * Get cluster info. + *

    + * Get basic build, version, and cluster information. ::: In Serverless, this + * API is retained for backward compatibility only. Some response fields, such + * as the version number, should be ignored. * * @see Documentation @@ -3329,6 +3366,114 @@ public InfoResponse info() throws IOException, ElasticsearchException { return this.transport.performRequest(InfoRequest._INSTANCE, InfoRequest._ENDPOINT, this.transportOptions); } + // ----- Endpoint: knn_search + + /** + * Run a knn search. + *

    + * NOTE: The kNN search API has been replaced by the knn option in + * the search API. + * + * @see Documentation + * on elastic.co + */ + + public KnnSearchResponse knnSearch(KnnSearchRequest request, Class tDocumentClass) + throws IOException, ElasticsearchException { + @SuppressWarnings("unchecked") + JsonEndpoint, ErrorResponse> endpoint = (JsonEndpoint, ErrorResponse>) KnnSearchRequest._ENDPOINT; + endpoint = new EndpointWithResponseMapperAttr<>(endpoint, + "co.elastic.clients:Deserializer:_global.knn_search.Response.TDocument", + getDeserializer(tDocumentClass)); + + return this.transport.performRequest(request, endpoint, this.transportOptions); + } + + /** + * Run a knn search. + *

    + * NOTE: The kNN search API has been replaced by the knn option in + * the search API. + * + * @param fn + * a function that initializes a builder to create the + * {@link KnnSearchRequest} + * @see Documentation + * on elastic.co + */ + + public final KnnSearchResponse knnSearch( + Function> fn, Class tDocumentClass) + throws IOException, ElasticsearchException { + return knnSearch(fn.apply(new KnnSearchRequest.Builder()).build(), tDocumentClass); + } + + /** + * Overload of {@link #knnSearch(KnnSearchRequest, Class)}, where Class is + * defined as Void, meaning the documents will not be deserialized. + */ + + public KnnSearchResponse knnSearch(KnnSearchRequest request) throws IOException, ElasticsearchException { + @SuppressWarnings("unchecked") + JsonEndpoint, ErrorResponse> endpoint = (JsonEndpoint, ErrorResponse>) KnnSearchRequest._ENDPOINT; + return this.transport.performRequest(request, endpoint, this.transportOptions); + } + + /** + * Overload of {@link #knnSearch(Function, Class)}, where Class is defined as + * Void, meaning the documents will not be deserialized. + */ + + public final KnnSearchResponse knnSearch( + Function> fn) + throws IOException, ElasticsearchException { + return knnSearch(fn.apply(new KnnSearchRequest.Builder()).build(), Void.class); + } + + /** + * Run a knn search. + *

    + * NOTE: The kNN search API has been replaced by the knn option in + * the search API. + * + * @see Documentation + * on elastic.co + */ + + public KnnSearchResponse knnSearch(KnnSearchRequest request, Type tDocumentType) + throws IOException, ElasticsearchException { + @SuppressWarnings("unchecked") + JsonEndpoint, ErrorResponse> endpoint = (JsonEndpoint, ErrorResponse>) KnnSearchRequest._ENDPOINT; + endpoint = new EndpointWithResponseMapperAttr<>(endpoint, + "co.elastic.clients:Deserializer:_global.knn_search.Response.TDocument", + getDeserializer(tDocumentType)); + + return this.transport.performRequest(request, endpoint, this.transportOptions); + } + + /** + * Run a knn search. + *

    + * NOTE: The kNN search API has been replaced by the knn option in + * the search API. + * + * @param fn + * a function that initializes a builder to create the + * {@link KnnSearchRequest} + * @see Documentation + * on elastic.co + */ + + public final KnnSearchResponse knnSearch( + Function> fn, Type tDocumentType) + throws IOException, ElasticsearchException { + return knnSearch(fn.apply(new KnnSearchRequest.Builder()).build(), tDocumentType); + } + // ----- Endpoint: mget /** @@ -4077,7 +4222,9 @@ public final OpenPointInTimeResponse openPointInTime( // ----- Endpoint: ping /** - * Ping the cluster. Get information about whether the cluster is running. + * Ping the cluster. + *

    + * Get information about whether the cluster is running. * * @see Documentation @@ -4090,8 +4237,9 @@ public BooleanResponse ping() throws IOException, ElasticsearchException { // ----- Endpoint: put_script /** - * Create or update a script or search template. Creates or updates a stored - * script or search template. + * Create or update a script or search template. + *

    + * Creates or updates a stored script or search template. * * @see Documentation @@ -4106,8 +4254,9 @@ public PutScriptResponse putScript(PutScriptRequest request) throws IOException, } /** - * Create or update a script or search template. Creates or updates a stored - * script or search template. + * Create or update a script or search template. + *

    + * Creates or updates a stored script or search template. * * @param fn * a function that initializes a builder to create the @@ -6189,10 +6338,11 @@ public final UpdateResponse update( // ----- Endpoint: update_by_query /** - * Update documents. Updates documents that match the specified query. If no - * query is specified, performs an update on every document in the data stream - * or index without modifying the source, which is useful for picking up mapping - * changes. + * Update documents. + *

    + * Updates documents that match the specified query. If no query is specified, + * performs an update on every document in the data stream or index without + * modifying the source, which is useful for picking up mapping changes. *

    * If the Elasticsearch security features are enabled, you must have the * following index privileges for the target data stream, index, or alias: @@ -6351,10 +6501,11 @@ public UpdateByQueryResponse updateByQuery(UpdateByQueryRequest request) } /** - * Update documents. Updates documents that match the specified query. If no - * query is specified, performs an update on every document in the data stream - * or index without modifying the source, which is useful for picking up mapping - * changes. + * Update documents. + *

    + * Updates documents that match the specified query. If no query is specified, + * performs an update on every document in the data stream or index without + * modifying the source, which is useful for picking up mapping changes. *

    * If the Elasticsearch security features are enabled, you must have the * following index privileges for the target data stream, index, or alias: diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/async_search/AsyncSearchResponseBase.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/async_search/AsyncSearchResponseBase.java index 847f538977..4d21f812c3 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/async_search/AsyncSearchResponseBase.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/async_search/AsyncSearchResponseBase.java @@ -19,6 +19,7 @@ package co.elastic.clients.elasticsearch.async_search; +import co.elastic.clients.elasticsearch._types.ErrorCause; import co.elastic.clients.json.JsonpDeserializable; import co.elastic.clients.json.JsonpDeserializer; import co.elastic.clients.json.JsonpMapper; @@ -35,6 +36,7 @@ import java.lang.Long; import java.lang.String; import java.util.Objects; +import java.util.function.Function; import javax.annotation.Nullable; //---------------------------------------------------------------- @@ -85,6 +87,9 @@ public abstract class AsyncSearchResponseBase implements JsonpSerializable { @Nullable private final Long completionTimeInMillis; + @Nullable + private final ErrorCause error; + // --------------------------------------------------------------------------------------------- protected AsyncSearchResponseBase(AbstractBuilder builder) { @@ -99,6 +104,7 @@ protected AsyncSearchResponseBase(AbstractBuilder builder) { this.startTimeInMillis = ApiTypeHelper.requireNonNull(builder.startTimeInMillis, this, "startTimeInMillis", 0); this.completionTime = builder.completionTime; this.completionTimeInMillis = builder.completionTimeInMillis; + this.error = builder.error; } @@ -189,6 +195,14 @@ public final Long completionTimeInMillis() { return this.completionTimeInMillis; } + /** + * API name: {@code error} + */ + @Nullable + public final ErrorCause error() { + return this.error; + } + /** * Serialize this object to JSON. */ @@ -234,6 +248,11 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) { generator.write(this.completionTimeInMillis); } + if (this.error != null) { + generator.writeKey("error"); + this.error.serialize(generator, mapper); + + } } @@ -268,6 +287,9 @@ public abstract static class AbstractBuilder> fn) { + return this.error(fn.apply(new ErrorCause.Builder()).build()); + } + protected abstract BuilderT self(); } @@ -378,6 +415,7 @@ protected static > void setupAsyncSea op.add(AbstractBuilder::completionTime, DateTime._DESERIALIZER, "completion_time"); op.add(AbstractBuilder::completionTimeInMillis, JsonpDeserializer.longDeserializer(), "completion_time_in_millis"); + op.add(AbstractBuilder::error, ErrorCause._DESERIALIZER, "error"); } diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/ElasticsearchCcrAsyncClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/ElasticsearchCcrAsyncClient.java index d3dde85f64..ba876ee09d 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/ElasticsearchCcrAsyncClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/ElasticsearchCcrAsyncClient.java @@ -105,10 +105,12 @@ public final CompletableFuture deleteAutoFollow // ----- Endpoint: ccr.follow /** - * Create a follower. Create a cross-cluster replication follower index that - * follows a specific leader index. When the API returns, the follower index - * exists and cross-cluster replication starts replicating operations from the - * leader index to the follower index. + * Create a follower. + *

    + * Create a cross-cluster replication follower index that follows a specific + * leader index. When the API returns, the follower index exists and + * cross-cluster replication starts replicating operations from the leader index + * to the follower index. * * @see Documentation @@ -123,10 +125,12 @@ public CompletableFuture follow(FollowRequest request) { } /** - * Create a follower. Create a cross-cluster replication follower index that - * follows a specific leader index. When the API returns, the follower index - * exists and cross-cluster replication starts replicating operations from the - * leader index to the follower index. + * Create a follower. + *

    + * Create a cross-cluster replication follower index that follows a specific + * leader index. When the API returns, the follower index exists and + * cross-cluster replication starts replicating operations from the leader index + * to the follower index. * * @param fn * a function that initializes a builder to create the @@ -226,8 +230,10 @@ public final CompletableFuture followStats( // ----- Endpoint: ccr.forget_follower /** - * Forget a follower. Remove the cross-cluster replication follower retention - * leases from the leader. + * Forget a follower. + *

    + * Remove the cross-cluster replication follower retention leases from the + * leader. *

    * A following index takes out retention leases on its leader index. These * leases are used to increase the likelihood that the shards of the leader @@ -261,8 +267,10 @@ public CompletableFuture forgetFollower(ForgetFollowerRe } /** - * Forget a follower. Remove the cross-cluster replication follower retention - * leases from the leader. + * Forget a follower. + *

    + * Remove the cross-cluster replication follower retention leases from the + * leader. *

    * A following index takes out retention leases on its leader index. These * leases are used to increase the likelihood that the shards of the leader @@ -450,12 +458,13 @@ public final CompletableFuture pauseFollow( // ----- Endpoint: ccr.put_auto_follow_pattern /** - * Create or update auto-follow patterns. Create a collection of cross-cluster - * replication auto-follow patterns for a remote cluster. Newly created indices - * on the remote cluster that match any of the patterns are automatically - * configured as follower indices. Indices on the remote cluster that were - * created before the auto-follow pattern was created will not be auto-followed - * even if they match the pattern. + * Create or update auto-follow patterns. + *

    + * Create a collection of cross-cluster replication auto-follow patterns for a + * remote cluster. Newly created indices on the remote cluster that match any of + * the patterns are automatically configured as follower indices. Indices on the + * remote cluster that were created before the auto-follow pattern was created + * will not be auto-followed even if they match the pattern. *

    * This API can also be used to update auto-follow patterns. NOTE: Follower * indices that were configured automatically before updating an auto-follow @@ -475,12 +484,13 @@ public CompletableFuture putAutoFollowPattern(PutA } /** - * Create or update auto-follow patterns. Create a collection of cross-cluster - * replication auto-follow patterns for a remote cluster. Newly created indices - * on the remote cluster that match any of the patterns are automatically - * configured as follower indices. Indices on the remote cluster that were - * created before the auto-follow pattern was created will not be auto-followed - * even if they match the pattern. + * Create or update auto-follow patterns. + *

    + * Create a collection of cross-cluster replication auto-follow patterns for a + * remote cluster. Newly created indices on the remote cluster that match any of + * the patterns are automatically configured as follower indices. Indices on the + * remote cluster that were created before the auto-follow pattern was created + * will not be auto-followed even if they match the pattern. *

    * This API can also be used to update auto-follow patterns. NOTE: Follower * indices that were configured automatically before updating an auto-follow @@ -549,11 +559,13 @@ public final CompletableFuture resumeAutoFollow // ----- Endpoint: ccr.resume_follow /** - * Resume a follower. Resume a cross-cluster replication follower index that was - * paused. The follower index could have been paused with the pause follower - * API. Alternatively it could be paused due to replication that cannot be - * retried due to failures during following tasks. When this API returns, the - * follower index will resume fetching operations from the leader index. + * Resume a follower. + *

    + * Resume a cross-cluster replication follower index that was paused. The + * follower index could have been paused with the pause follower API. + * Alternatively it could be paused due to replication that cannot be retried + * due to failures during following tasks. When this API returns, the follower + * index will resume fetching operations from the leader index. * * @see Documentation @@ -568,11 +580,13 @@ public CompletableFuture resumeFollow(ResumeFollowRequest } /** - * Resume a follower. Resume a cross-cluster replication follower index that was - * paused. The follower index could have been paused with the pause follower - * API. Alternatively it could be paused due to replication that cannot be - * retried due to failures during following tasks. When this API returns, the - * follower index will resume fetching operations from the leader index. + * Resume a follower. + *

    + * Resume a cross-cluster replication follower index that was paused. The + * follower index could have been paused with the pause follower API. + * Alternatively it could be paused due to replication that cannot be retried + * due to failures during following tasks. When this API returns, the follower + * index will resume fetching operations from the leader index. * * @param fn * a function that initializes a builder to create the diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/ElasticsearchCcrClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/ElasticsearchCcrClient.java index 87cdd47a3d..accce4a706 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/ElasticsearchCcrClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/ElasticsearchCcrClient.java @@ -107,10 +107,12 @@ public final DeleteAutoFollowPatternResponse deleteAutoFollowPattern( // ----- Endpoint: ccr.follow /** - * Create a follower. Create a cross-cluster replication follower index that - * follows a specific leader index. When the API returns, the follower index - * exists and cross-cluster replication starts replicating operations from the - * leader index to the follower index. + * Create a follower. + *

    + * Create a cross-cluster replication follower index that follows a specific + * leader index. When the API returns, the follower index exists and + * cross-cluster replication starts replicating operations from the leader index + * to the follower index. * * @see Documentation @@ -125,10 +127,12 @@ public FollowResponse follow(FollowRequest request) throws IOException, Elastics } /** - * Create a follower. Create a cross-cluster replication follower index that - * follows a specific leader index. When the API returns, the follower index - * exists and cross-cluster replication starts replicating operations from the - * leader index to the follower index. + * Create a follower. + *

    + * Create a cross-cluster replication follower index that follows a specific + * leader index. When the API returns, the follower index exists and + * cross-cluster replication starts replicating operations from the leader index + * to the follower index. * * @param fn * a function that initializes a builder to create the @@ -229,8 +233,10 @@ public final FollowStatsResponse followStats( // ----- Endpoint: ccr.forget_follower /** - * Forget a follower. Remove the cross-cluster replication follower retention - * leases from the leader. + * Forget a follower. + *

    + * Remove the cross-cluster replication follower retention leases from the + * leader. *

    * A following index takes out retention leases on its leader index. These * leases are used to increase the likelihood that the shards of the leader @@ -265,8 +271,10 @@ public ForgetFollowerResponse forgetFollower(ForgetFollowerRequest request) } /** - * Forget a follower. Remove the cross-cluster replication follower retention - * leases from the leader. + * Forget a follower. + *

    + * Remove the cross-cluster replication follower retention leases from the + * leader. *

    * A following index takes out retention leases on its leader index. These * leases are used to increase the likelihood that the shards of the leader @@ -459,12 +467,13 @@ public final PauseFollowResponse pauseFollow( // ----- Endpoint: ccr.put_auto_follow_pattern /** - * Create or update auto-follow patterns. Create a collection of cross-cluster - * replication auto-follow patterns for a remote cluster. Newly created indices - * on the remote cluster that match any of the patterns are automatically - * configured as follower indices. Indices on the remote cluster that were - * created before the auto-follow pattern was created will not be auto-followed - * even if they match the pattern. + * Create or update auto-follow patterns. + *

    + * Create a collection of cross-cluster replication auto-follow patterns for a + * remote cluster. Newly created indices on the remote cluster that match any of + * the patterns are automatically configured as follower indices. Indices on the + * remote cluster that were created before the auto-follow pattern was created + * will not be auto-followed even if they match the pattern. *

    * This API can also be used to update auto-follow patterns. NOTE: Follower * indices that were configured automatically before updating an auto-follow @@ -485,12 +494,13 @@ public PutAutoFollowPatternResponse putAutoFollowPattern(PutAutoFollowPatternReq } /** - * Create or update auto-follow patterns. Create a collection of cross-cluster - * replication auto-follow patterns for a remote cluster. Newly created indices - * on the remote cluster that match any of the patterns are automatically - * configured as follower indices. Indices on the remote cluster that were - * created before the auto-follow pattern was created will not be auto-followed - * even if they match the pattern. + * Create or update auto-follow patterns. + *

    + * Create a collection of cross-cluster replication auto-follow patterns for a + * remote cluster. Newly created indices on the remote cluster that match any of + * the patterns are automatically configured as follower indices. Indices on the + * remote cluster that were created before the auto-follow pattern was created + * will not be auto-followed even if they match the pattern. *

    * This API can also be used to update auto-follow patterns. NOTE: Follower * indices that were configured automatically before updating an auto-follow @@ -561,11 +571,13 @@ public final ResumeAutoFollowPatternResponse resumeAutoFollowPattern( // ----- Endpoint: ccr.resume_follow /** - * Resume a follower. Resume a cross-cluster replication follower index that was - * paused. The follower index could have been paused with the pause follower - * API. Alternatively it could be paused due to replication that cannot be - * retried due to failures during following tasks. When this API returns, the - * follower index will resume fetching operations from the leader index. + * Resume a follower. + *

    + * Resume a cross-cluster replication follower index that was paused. The + * follower index could have been paused with the pause follower API. + * Alternatively it could be paused due to replication that cannot be retried + * due to failures during following tasks. When this API returns, the follower + * index will resume fetching operations from the leader index. * * @see Documentation @@ -580,11 +592,13 @@ public ResumeFollowResponse resumeFollow(ResumeFollowRequest request) throws IOE } /** - * Resume a follower. Resume a cross-cluster replication follower index that was - * paused. The follower index could have been paused with the pause follower - * API. Alternatively it could be paused due to replication that cannot be - * retried due to failures during following tasks. When this API returns, the - * follower index will resume fetching operations from the leader index. + * Resume a follower. + *

    + * Resume a cross-cluster replication follower index that was paused. The + * follower index could have been paused with the pause follower API. + * Alternatively it could be paused due to replication that cannot be retried + * due to failures during following tasks. When this API returns, the follower + * index will resume fetching operations from the leader index. * * @param fn * a function that initializes a builder to create the diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/FollowRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/FollowRequest.java index a9e968997a..55793614ec 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/FollowRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/FollowRequest.java @@ -62,10 +62,12 @@ // typedef: ccr.follow.Request /** - * Create a follower. Create a cross-cluster replication follower index that - * follows a specific leader index. When the API returns, the follower index - * exists and cross-cluster replication starts replicating operations from the - * leader index to the follower index. + * Create a follower. + *

    + * Create a cross-cluster replication follower index that follows a specific + * leader index. When the API returns, the follower index exists and + * cross-cluster replication starts replicating operations from the leader index + * to the follower index. * * @see API * specification diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/ForgetFollowerRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/ForgetFollowerRequest.java index 0881761e6d..d82c981d62 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/ForgetFollowerRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/ForgetFollowerRequest.java @@ -58,8 +58,10 @@ // typedef: ccr.forget_follower.Request /** - * Forget a follower. Remove the cross-cluster replication follower retention - * leases from the leader. + * Forget a follower. + *

    + * Remove the cross-cluster replication follower retention leases from the + * leader. *

    * A following index takes out retention leases on its leader index. These * leases are used to increase the likelihood that the shards of the leader diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/PutAutoFollowPatternRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/PutAutoFollowPatternRequest.java index a98cd5d5db..26f6535c9d 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/PutAutoFollowPatternRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/PutAutoFollowPatternRequest.java @@ -61,12 +61,13 @@ // typedef: ccr.put_auto_follow_pattern.Request /** - * Create or update auto-follow patterns. Create a collection of cross-cluster - * replication auto-follow patterns for a remote cluster. Newly created indices - * on the remote cluster that match any of the patterns are automatically - * configured as follower indices. Indices on the remote cluster that were - * created before the auto-follow pattern was created will not be auto-followed - * even if they match the pattern. + * Create or update auto-follow patterns. + *

    + * Create a collection of cross-cluster replication auto-follow patterns for a + * remote cluster. Newly created indices on the remote cluster that match any of + * the patterns are automatically configured as follower indices. Indices on the + * remote cluster that were created before the auto-follow pattern was created + * will not be auto-followed even if they match the pattern. *

    * This API can also be used to update auto-follow patterns. NOTE: Follower * indices that were configured automatically before updating an auto-follow diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/ResumeFollowRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/ResumeFollowRequest.java index 587e9efb82..7011f360a5 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/ResumeFollowRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ccr/ResumeFollowRequest.java @@ -59,11 +59,13 @@ // typedef: ccr.resume_follow.Request /** - * Resume a follower. Resume a cross-cluster replication follower index that was - * paused. The follower index could have been paused with the pause follower - * API. Alternatively it could be paused due to replication that cannot be - * retried due to failures during following tasks. When this API returns, the - * follower index will resume fetching operations from the leader index. + * Resume a follower. + *

    + * Resume a cross-cluster replication follower index that was paused. The + * follower index could have been paused with the pause follower API. + * Alternatively it could be paused due to replication that cannot be retried + * due to failures during following tasks. When this API returns, the follower + * index will resume fetching operations from the leader index. * * @see API * specification diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/AllocationExplainRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/AllocationExplainRequest.java index dcaaaecc8f..8b7d8e2611 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/AllocationExplainRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/AllocationExplainRequest.java @@ -60,16 +60,18 @@ // typedef: cluster.allocation_explain.Request /** - * Explain the shard allocations. Get explanations for shard allocations in the - * cluster. This API accepts the current_node, index, primary and shard - * parameters in the request body or in query parameters, but not in both at the - * same time. For unassigned shards, it provides an explanation for why the - * shard is unassigned. For assigned shards, it provides an explanation for why - * the shard is remaining on its current node and has not moved or rebalanced to - * another node. This API can be very useful when attempting to diagnose why a - * shard is unassigned or why a shard continues to remain on its current node - * when you might expect otherwise. Refer to the linked documentation for - * examples of how to troubleshoot allocation issues using this API. + * Explain the shard allocations. + *

    + * Get explanations for shard allocations in the cluster. This API accepts the + * current_node, index, primary and shard parameters in the request body or in + * query parameters, but not in both at the same time. For unassigned shards, it + * provides an explanation for why the shard is unassigned. For assigned shards, + * it provides an explanation for why the shard is remaining on its current node + * and has not moved or rebalanced to another node. This API can be very useful + * when attempting to diagnose why a shard is unassigned or why a shard + * continues to remain on its current node when you might expect otherwise. + * Refer to the linked documentation for examples of how to troubleshoot + * allocation issues using this API. * * @see API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ClusterInfoRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ClusterInfoRequest.java index e0cbc76f9a..22646ebbfa 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ClusterInfoRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ClusterInfoRequest.java @@ -58,7 +58,9 @@ // typedef: cluster.info.Request /** - * Get cluster info. Returns basic information about the cluster. + * Get cluster info. + *

    + * Returns basic information about the cluster. * * @see API * specification diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ClusterStatsRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ClusterStatsRequest.java index 0d4e38fc4d..76217bc81f 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ClusterStatsRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ClusterStatsRequest.java @@ -59,9 +59,11 @@ // typedef: cluster.stats.Request /** - * Get cluster statistics. Get basic index metrics (shard numbers, store size, - * memory usage) and information about the current nodes that form the cluster - * (number, roles, os, jvm versions, memory usage, cpu and installed plugins). + * Get cluster statistics. + *

    + * Get basic index metrics (shard numbers, store size, memory usage) and + * information about the current nodes that form the cluster (number, roles, os, + * jvm versions, memory usage, cpu and installed plugins). * * @see API * specification diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/DeleteComponentTemplateRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/DeleteComponentTemplateRequest.java index 095f694f79..2ab2efd72d 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/DeleteComponentTemplateRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/DeleteComponentTemplateRequest.java @@ -58,9 +58,10 @@ // typedef: cluster.delete_component_template.Request /** - * Delete component templates. Component templates are building blocks for - * constructing index templates that specify index mappings, settings, and - * aliases. + * Delete component templates. + *

    + * Component templates are building blocks for constructing index templates that + * specify index mappings, settings, and aliases. * * @see API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/DeleteVotingConfigExclusionsRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/DeleteVotingConfigExclusionsRequest.java index f2693fb577..3c01983203 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/DeleteVotingConfigExclusionsRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/DeleteVotingConfigExclusionsRequest.java @@ -58,8 +58,9 @@ // typedef: cluster.delete_voting_config_exclusions.Request /** - * Clear cluster voting config exclusions. Remove master-eligible nodes from the - * voting configuration exclusion list. + * Clear cluster voting config exclusions. + *

    + * Remove master-eligible nodes from the voting configuration exclusion list. * * @see API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ElasticsearchClusterAsyncClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ElasticsearchClusterAsyncClient.java index 1d54471ddd..9cca5bca50 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ElasticsearchClusterAsyncClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ElasticsearchClusterAsyncClient.java @@ -71,16 +71,18 @@ public ElasticsearchClusterAsyncClient withTransportOptions(@Nullable TransportO // ----- Endpoint: cluster.allocation_explain /** - * Explain the shard allocations. Get explanations for shard allocations in the - * cluster. This API accepts the current_node, index, primary and shard - * parameters in the request body or in query parameters, but not in both at the - * same time. For unassigned shards, it provides an explanation for why the - * shard is unassigned. For assigned shards, it provides an explanation for why - * the shard is remaining on its current node and has not moved or rebalanced to - * another node. This API can be very useful when attempting to diagnose why a - * shard is unassigned or why a shard continues to remain on its current node - * when you might expect otherwise. Refer to the linked documentation for - * examples of how to troubleshoot allocation issues using this API. + * Explain the shard allocations. + *

    + * Get explanations for shard allocations in the cluster. This API accepts the + * current_node, index, primary and shard parameters in the request body or in + * query parameters, but not in both at the same time. For unassigned shards, it + * provides an explanation for why the shard is unassigned. For assigned shards, + * it provides an explanation for why the shard is remaining on its current node + * and has not moved or rebalanced to another node. This API can be very useful + * when attempting to diagnose why a shard is unassigned or why a shard + * continues to remain on its current node when you might expect otherwise. + * Refer to the linked documentation for examples of how to troubleshoot + * allocation issues using this API. * * @see Documentation @@ -95,16 +97,18 @@ public CompletableFuture allocationExplain(Allocation } /** - * Explain the shard allocations. Get explanations for shard allocations in the - * cluster. This API accepts the current_node, index, primary and shard - * parameters in the request body or in query parameters, but not in both at the - * same time. For unassigned shards, it provides an explanation for why the - * shard is unassigned. For assigned shards, it provides an explanation for why - * the shard is remaining on its current node and has not moved or rebalanced to - * another node. This API can be very useful when attempting to diagnose why a - * shard is unassigned or why a shard continues to remain on its current node - * when you might expect otherwise. Refer to the linked documentation for - * examples of how to troubleshoot allocation issues using this API. + * Explain the shard allocations. + *

    + * Get explanations for shard allocations in the cluster. This API accepts the + * current_node, index, primary and shard parameters in the request body or in + * query parameters, but not in both at the same time. For unassigned shards, it + * provides an explanation for why the shard is unassigned. For assigned shards, + * it provides an explanation for why the shard is remaining on its current node + * and has not moved or rebalanced to another node. This API can be very useful + * when attempting to diagnose why a shard is unassigned or why a shard + * continues to remain on its current node when you might expect otherwise. + * Refer to the linked documentation for examples of how to troubleshoot + * allocation issues using this API. * * @param fn * a function that initializes a builder to create the @@ -120,16 +124,18 @@ public final CompletableFuture allocationExplain( } /** - * Explain the shard allocations. Get explanations for shard allocations in the - * cluster. This API accepts the current_node, index, primary and shard - * parameters in the request body or in query parameters, but not in both at the - * same time. For unassigned shards, it provides an explanation for why the - * shard is unassigned. For assigned shards, it provides an explanation for why - * the shard is remaining on its current node and has not moved or rebalanced to - * another node. This API can be very useful when attempting to diagnose why a - * shard is unassigned or why a shard continues to remain on its current node - * when you might expect otherwise. Refer to the linked documentation for - * examples of how to troubleshoot allocation issues using this API. + * Explain the shard allocations. + *

    + * Get explanations for shard allocations in the cluster. This API accepts the + * current_node, index, primary and shard parameters in the request body or in + * query parameters, but not in both at the same time. For unassigned shards, it + * provides an explanation for why the shard is unassigned. For assigned shards, + * it provides an explanation for why the shard is remaining on its current node + * and has not moved or rebalanced to another node. This API can be very useful + * when attempting to diagnose why a shard is unassigned or why a shard + * continues to remain on its current node when you might expect otherwise. + * Refer to the linked documentation for examples of how to troubleshoot + * allocation issues using this API. * * @see Documentation @@ -144,9 +150,10 @@ public CompletableFuture allocationExplain() { // ----- Endpoint: cluster.delete_component_template /** - * Delete component templates. Component templates are building blocks for - * constructing index templates that specify index mappings, settings, and - * aliases. + * Delete component templates. + *

    + * Component templates are building blocks for constructing index templates that + * specify index mappings, settings, and aliases. * * @see Documentation @@ -162,9 +169,10 @@ public CompletableFuture deleteComponentTemplat } /** - * Delete component templates. Component templates are building blocks for - * constructing index templates that specify index mappings, settings, and - * aliases. + * Delete component templates. + *

    + * Component templates are building blocks for constructing index templates that + * specify index mappings, settings, and aliases. * * @param fn * a function that initializes a builder to create the @@ -182,8 +190,9 @@ public final CompletableFuture deleteComponentT // ----- Endpoint: cluster.delete_voting_config_exclusions /** - * Clear cluster voting config exclusions. Remove master-eligible nodes from the - * voting configuration exclusion list. + * Clear cluster voting config exclusions. + *

    + * Remove master-eligible nodes from the voting configuration exclusion list. * * @see Documentation @@ -199,8 +208,9 @@ public CompletableFuture deleteVotingConfigExclusions( } /** - * Clear cluster voting config exclusions. Remove master-eligible nodes from the - * voting configuration exclusion list. + * Clear cluster voting config exclusions. + *

    + * Remove master-eligible nodes from the voting configuration exclusion list. * * @param fn * a function that initializes a builder to create the @@ -216,8 +226,9 @@ public final CompletableFuture deleteVotingConfigExclusions( } /** - * Clear cluster voting config exclusions. Remove master-eligible nodes from the - * voting configuration exclusion list. + * Clear cluster voting config exclusions. + *

    + * Remove master-eligible nodes from the voting configuration exclusion list. * * @see Documentation @@ -232,8 +243,9 @@ public CompletableFuture deleteVotingConfigExclusions() { // ----- Endpoint: cluster.exists_component_template /** - * Check component templates. Returns information about whether a particular - * component template exists. + * Check component templates. + *

    + * Returns information about whether a particular component template exists. * * @see Documentation @@ -248,8 +260,9 @@ public CompletableFuture existsComponentTemplate(ExistsComponen } /** - * Check component templates. Returns information about whether a particular - * component template exists. + * Check component templates. + *

    + * Returns information about whether a particular component template exists. * * @param fn * a function that initializes a builder to create the @@ -267,7 +280,9 @@ public final CompletableFuture existsComponentTemplate( // ----- Endpoint: cluster.get_component_template /** - * Get component templates. Get information about component templates. + * Get component templates. + *

    + * Get information about component templates. * * @see Documentation @@ -282,7 +297,9 @@ public CompletableFuture getComponentTemplate(GetC } /** - * Get component templates. Get information about component templates. + * Get component templates. + *

    + * Get information about component templates. * * @param fn * a function that initializes a builder to create the @@ -298,7 +315,9 @@ public final CompletableFuture getComponentTemplat } /** - * Get component templates. Get information about component templates. + * Get component templates. + *

    + * Get information about component templates. * * @see Documentation @@ -453,7 +472,9 @@ public CompletableFuture health() { // ----- Endpoint: cluster.info /** - * Get cluster info. Returns basic information about the cluster. + * Get cluster info. + *

    + * Returns basic information about the cluster. * * @see Documentation @@ -468,7 +489,9 @@ public CompletableFuture info(ClusterInfoRequest request) { } /** - * Get cluster info. Returns basic information about the cluster. + * Get cluster info. + *

    + * Returns basic information about the cluster. * * @param fn * a function that initializes a builder to create the @@ -486,9 +509,10 @@ public final CompletableFuture info( // ----- Endpoint: cluster.pending_tasks /** - * Get the pending cluster tasks. Get information about cluster-level changes - * (such as create index, update mapping, allocate or fail shard) that have not - * yet taken effect. + * Get the pending cluster tasks. + *

    + * Get information about cluster-level changes (such as create index, update + * mapping, allocate or fail shard) that have not yet taken effect. *

    * NOTE: This API returns a list of any pending updates to the cluster state. * These are distinct from the tasks reported by the task management API which @@ -510,9 +534,10 @@ public CompletableFuture pendingTasks(PendingTasksRequest } /** - * Get the pending cluster tasks. Get information about cluster-level changes - * (such as create index, update mapping, allocate or fail shard) that have not - * yet taken effect. + * Get the pending cluster tasks. + *

    + * Get information about cluster-level changes (such as create index, update + * mapping, allocate or fail shard) that have not yet taken effect. *

    * NOTE: This API returns a list of any pending updates to the cluster state. * These are distinct from the tasks reported by the task management API which @@ -535,9 +560,10 @@ public final CompletableFuture pendingTasks( } /** - * Get the pending cluster tasks. Get information about cluster-level changes - * (such as create index, update mapping, allocate or fail shard) that have not - * yet taken effect. + * Get the pending cluster tasks. + *

    + * Get information about cluster-level changes (such as create index, update + * mapping, allocate or fail shard) that have not yet taken effect. *

    * NOTE: This API returns a list of any pending updates to the cluster state. * These are distinct from the tasks reported by the task management API which @@ -559,16 +585,17 @@ public CompletableFuture pendingTasks() { // ----- Endpoint: cluster.post_voting_config_exclusions /** - * Update voting configuration exclusions. Update the cluster voting config - * exclusions by node IDs or node names. By default, if there are more than - * three master-eligible nodes in the cluster and you remove fewer than half of - * the master-eligible nodes in the cluster at once, the voting configuration - * automatically shrinks. If you want to shrink the voting configuration to - * contain fewer than three nodes or to remove half or more of the - * master-eligible nodes in the cluster at once, use this API to remove - * departing nodes from the voting configuration manually. The API adds an entry - * for each specified node to the cluster’s voting configuration exclusions - * list. It then waits until the cluster has reconfigured its voting + * Update voting configuration exclusions. + *

    + * Update the cluster voting config exclusions by node IDs or node names. By + * default, if there are more than three master-eligible nodes in the cluster + * and you remove fewer than half of the master-eligible nodes in the cluster at + * once, the voting configuration automatically shrinks. If you want to shrink + * the voting configuration to contain fewer than three nodes or to remove half + * or more of the master-eligible nodes in the cluster at once, use this API to + * remove departing nodes from the voting configuration manually. The API adds + * an entry for each specified node to the cluster’s voting configuration + * exclusions list. It then waits until the cluster has reconfigured its voting * configuration to exclude the specified nodes. *

    * Clusters should have no voting configuration exclusions in normal operation. @@ -609,16 +636,17 @@ public CompletableFuture postVotingConfigExclusions(PostVotingC } /** - * Update voting configuration exclusions. Update the cluster voting config - * exclusions by node IDs or node names. By default, if there are more than - * three master-eligible nodes in the cluster and you remove fewer than half of - * the master-eligible nodes in the cluster at once, the voting configuration - * automatically shrinks. If you want to shrink the voting configuration to - * contain fewer than three nodes or to remove half or more of the - * master-eligible nodes in the cluster at once, use this API to remove - * departing nodes from the voting configuration manually. The API adds an entry - * for each specified node to the cluster’s voting configuration exclusions - * list. It then waits until the cluster has reconfigured its voting + * Update voting configuration exclusions. + *

    + * Update the cluster voting config exclusions by node IDs or node names. By + * default, if there are more than three master-eligible nodes in the cluster + * and you remove fewer than half of the master-eligible nodes in the cluster at + * once, the voting configuration automatically shrinks. If you want to shrink + * the voting configuration to contain fewer than three nodes or to remove half + * or more of the master-eligible nodes in the cluster at once, use this API to + * remove departing nodes from the voting configuration manually. The API adds + * an entry for each specified node to the cluster’s voting configuration + * exclusions list. It then waits until the cluster has reconfigured its voting * configuration to exclude the specified nodes. *

    * Clusters should have no voting configuration exclusions in normal operation. @@ -660,16 +688,17 @@ public final CompletableFuture postVotingConfigExclusions( } /** - * Update voting configuration exclusions. Update the cluster voting config - * exclusions by node IDs or node names. By default, if there are more than - * three master-eligible nodes in the cluster and you remove fewer than half of - * the master-eligible nodes in the cluster at once, the voting configuration - * automatically shrinks. If you want to shrink the voting configuration to - * contain fewer than three nodes or to remove half or more of the - * master-eligible nodes in the cluster at once, use this API to remove - * departing nodes from the voting configuration manually. The API adds an entry - * for each specified node to the cluster’s voting configuration exclusions - * list. It then waits until the cluster has reconfigured its voting + * Update voting configuration exclusions. + *

    + * Update the cluster voting config exclusions by node IDs or node names. By + * default, if there are more than three master-eligible nodes in the cluster + * and you remove fewer than half of the master-eligible nodes in the cluster at + * once, the voting configuration automatically shrinks. If you want to shrink + * the voting configuration to contain fewer than three nodes or to remove half + * or more of the master-eligible nodes in the cluster at once, use this API to + * remove departing nodes from the voting configuration manually. The API adds + * an entry for each specified node to the cluster’s voting configuration + * exclusions list. It then waits until the cluster has reconfigured its voting * configuration to exclude the specified nodes. *

    * Clusters should have no voting configuration exclusions in normal operation. @@ -710,9 +739,10 @@ public CompletableFuture postVotingConfigExclusions() { // ----- Endpoint: cluster.put_component_template /** - * Create or update a component template. Component templates are building - * blocks for constructing index templates that specify index mappings, - * settings, and aliases. + * Create or update a component template. + *

    + * Component templates are building blocks for constructing index templates that + * specify index mappings, settings, and aliases. *

    * An index template can be composed of multiple component templates. To use a * component template, specify it in an index template’s @@ -751,9 +781,10 @@ public CompletableFuture putComponentTemplate(PutC } /** - * Create or update a component template. Component templates are building - * blocks for constructing index templates that specify index mappings, - * settings, and aliases. + * Create or update a component template. + *

    + * Component templates are building blocks for constructing index templates that + * specify index mappings, settings, and aliases. *

    * An index template can be composed of multiple component templates. To use a * component template, specify it in an index template’s @@ -955,10 +986,12 @@ public CompletableFuture remoteInfo() { // ----- Endpoint: cluster.reroute /** - * Reroute the cluster. Manually change the allocation of individual shards in - * the cluster. For example, a shard can be moved from one node to another - * explicitly, an allocation can be canceled, and an unassigned shard can be - * explicitly allocated to a specific node. + * Reroute the cluster. + *

    + * Manually change the allocation of individual shards in the cluster. For + * example, a shard can be moved from one node to another explicitly, an + * allocation can be canceled, and an unassigned shard can be explicitly + * allocated to a specific node. *

    * It is important to note that after processing any reroute commands * Elasticsearch will perform rebalancing as normal (respecting the values of @@ -996,10 +1029,12 @@ public CompletableFuture reroute(RerouteRequest request) { } /** - * Reroute the cluster. Manually change the allocation of individual shards in - * the cluster. For example, a shard can be moved from one node to another - * explicitly, an allocation can be canceled, and an unassigned shard can be - * explicitly allocated to a specific node. + * Reroute the cluster. + *

    + * Manually change the allocation of individual shards in the cluster. For + * example, a shard can be moved from one node to another explicitly, an + * allocation can be canceled, and an unassigned shard can be explicitly + * allocated to a specific node. *

    * It is important to note that after processing any reroute commands * Elasticsearch will perform rebalancing as normal (respecting the values of @@ -1038,10 +1073,12 @@ public final CompletableFuture reroute( } /** - * Reroute the cluster. Manually change the allocation of individual shards in - * the cluster. For example, a shard can be moved from one node to another - * explicitly, an allocation can be canceled, and an unassigned shard can be - * explicitly allocated to a specific node. + * Reroute the cluster. + *

    + * Manually change the allocation of individual shards in the cluster. For + * example, a shard can be moved from one node to another explicitly, an + * allocation can be canceled, and an unassigned shard can be explicitly + * allocated to a specific node. *

    * It is important to note that after processing any reroute commands * Elasticsearch will perform rebalancing as normal (respecting the values of @@ -1079,8 +1116,9 @@ public CompletableFuture reroute() { // ----- Endpoint: cluster.state /** - * Get the cluster state. Get comprehensive information about the state of the - * cluster. + * Get the cluster state. + *

    + * Get comprehensive information about the state of the cluster. *

    * The cluster state is an internal data structure which keeps track of a * variety of information needed by every node, including the identity and @@ -1123,8 +1161,9 @@ public CompletableFuture state(StateRequest request) { } /** - * Get the cluster state. Get comprehensive information about the state of the - * cluster. + * Get the cluster state. + *

    + * Get comprehensive information about the state of the cluster. *

    * The cluster state is an internal data structure which keeps track of a * variety of information needed by every node, including the identity and @@ -1168,8 +1207,9 @@ public final CompletableFuture state( } /** - * Get the cluster state. Get comprehensive information about the state of the - * cluster. + * Get the cluster state. + *

    + * Get comprehensive information about the state of the cluster. *

    * The cluster state is an internal data structure which keeps track of a * variety of information needed by every node, including the identity and @@ -1212,9 +1252,11 @@ public CompletableFuture state() { // ----- Endpoint: cluster.stats /** - * Get cluster statistics. Get basic index metrics (shard numbers, store size, - * memory usage) and information about the current nodes that form the cluster - * (number, roles, os, jvm versions, memory usage, cpu and installed plugins). + * Get cluster statistics. + *

    + * Get basic index metrics (shard numbers, store size, memory usage) and + * information about the current nodes that form the cluster (number, roles, os, + * jvm versions, memory usage, cpu and installed plugins). * * @see Documentation @@ -1229,9 +1271,11 @@ public CompletableFuture stats(ClusterStatsRequest request } /** - * Get cluster statistics. Get basic index metrics (shard numbers, store size, - * memory usage) and information about the current nodes that form the cluster - * (number, roles, os, jvm versions, memory usage, cpu and installed plugins). + * Get cluster statistics. + *

    + * Get basic index metrics (shard numbers, store size, memory usage) and + * information about the current nodes that form the cluster (number, roles, os, + * jvm versions, memory usage, cpu and installed plugins). * * @param fn * a function that initializes a builder to create the @@ -1247,9 +1291,11 @@ public final CompletableFuture stats( } /** - * Get cluster statistics. Get basic index metrics (shard numbers, store size, - * memory usage) and information about the current nodes that form the cluster - * (number, roles, os, jvm versions, memory usage, cpu and installed plugins). + * Get cluster statistics. + *

    + * Get basic index metrics (shard numbers, store size, memory usage) and + * information about the current nodes that form the cluster (number, roles, os, + * jvm versions, memory usage, cpu and installed plugins). * * @see Documentation diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ElasticsearchClusterClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ElasticsearchClusterClient.java index 4e6b8f391c..0465f61838 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ElasticsearchClusterClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ElasticsearchClusterClient.java @@ -69,16 +69,18 @@ public ElasticsearchClusterClient withTransportOptions(@Nullable TransportOption // ----- Endpoint: cluster.allocation_explain /** - * Explain the shard allocations. Get explanations for shard allocations in the - * cluster. This API accepts the current_node, index, primary and shard - * parameters in the request body or in query parameters, but not in both at the - * same time. For unassigned shards, it provides an explanation for why the - * shard is unassigned. For assigned shards, it provides an explanation for why - * the shard is remaining on its current node and has not moved or rebalanced to - * another node. This API can be very useful when attempting to diagnose why a - * shard is unassigned or why a shard continues to remain on its current node - * when you might expect otherwise. Refer to the linked documentation for - * examples of how to troubleshoot allocation issues using this API. + * Explain the shard allocations. + *

    + * Get explanations for shard allocations in the cluster. This API accepts the + * current_node, index, primary and shard parameters in the request body or in + * query parameters, but not in both at the same time. For unassigned shards, it + * provides an explanation for why the shard is unassigned. For assigned shards, + * it provides an explanation for why the shard is remaining on its current node + * and has not moved or rebalanced to another node. This API can be very useful + * when attempting to diagnose why a shard is unassigned or why a shard + * continues to remain on its current node when you might expect otherwise. + * Refer to the linked documentation for examples of how to troubleshoot + * allocation issues using this API. * * @see Documentation @@ -94,16 +96,18 @@ public AllocationExplainResponse allocationExplain(AllocationExplainRequest requ } /** - * Explain the shard allocations. Get explanations for shard allocations in the - * cluster. This API accepts the current_node, index, primary and shard - * parameters in the request body or in query parameters, but not in both at the - * same time. For unassigned shards, it provides an explanation for why the - * shard is unassigned. For assigned shards, it provides an explanation for why - * the shard is remaining on its current node and has not moved or rebalanced to - * another node. This API can be very useful when attempting to diagnose why a - * shard is unassigned or why a shard continues to remain on its current node - * when you might expect otherwise. Refer to the linked documentation for - * examples of how to troubleshoot allocation issues using this API. + * Explain the shard allocations. + *

    + * Get explanations for shard allocations in the cluster. This API accepts the + * current_node, index, primary and shard parameters in the request body or in + * query parameters, but not in both at the same time. For unassigned shards, it + * provides an explanation for why the shard is unassigned. For assigned shards, + * it provides an explanation for why the shard is remaining on its current node + * and has not moved or rebalanced to another node. This API can be very useful + * when attempting to diagnose why a shard is unassigned or why a shard + * continues to remain on its current node when you might expect otherwise. + * Refer to the linked documentation for examples of how to troubleshoot + * allocation issues using this API. * * @param fn * a function that initializes a builder to create the @@ -120,16 +124,18 @@ public final AllocationExplainResponse allocationExplain( } /** - * Explain the shard allocations. Get explanations for shard allocations in the - * cluster. This API accepts the current_node, index, primary and shard - * parameters in the request body or in query parameters, but not in both at the - * same time. For unassigned shards, it provides an explanation for why the - * shard is unassigned. For assigned shards, it provides an explanation for why - * the shard is remaining on its current node and has not moved or rebalanced to - * another node. This API can be very useful when attempting to diagnose why a - * shard is unassigned or why a shard continues to remain on its current node - * when you might expect otherwise. Refer to the linked documentation for - * examples of how to troubleshoot allocation issues using this API. + * Explain the shard allocations. + *

    + * Get explanations for shard allocations in the cluster. This API accepts the + * current_node, index, primary and shard parameters in the request body or in + * query parameters, but not in both at the same time. For unassigned shards, it + * provides an explanation for why the shard is unassigned. For assigned shards, + * it provides an explanation for why the shard is remaining on its current node + * and has not moved or rebalanced to another node. This API can be very useful + * when attempting to diagnose why a shard is unassigned or why a shard + * continues to remain on its current node when you might expect otherwise. + * Refer to the linked documentation for examples of how to troubleshoot + * allocation issues using this API. * * @see Documentation @@ -144,9 +150,10 @@ public AllocationExplainResponse allocationExplain() throws IOException, Elastic // ----- Endpoint: cluster.delete_component_template /** - * Delete component templates. Component templates are building blocks for - * constructing index templates that specify index mappings, settings, and - * aliases. + * Delete component templates. + *

    + * Component templates are building blocks for constructing index templates that + * specify index mappings, settings, and aliases. * * @see Documentation @@ -162,9 +169,10 @@ public DeleteComponentTemplateResponse deleteComponentTemplate(DeleteComponentTe } /** - * Delete component templates. Component templates are building blocks for - * constructing index templates that specify index mappings, settings, and - * aliases. + * Delete component templates. + *

    + * Component templates are building blocks for constructing index templates that + * specify index mappings, settings, and aliases. * * @param fn * a function that initializes a builder to create the @@ -183,8 +191,9 @@ public final DeleteComponentTemplateResponse deleteComponentTemplate( // ----- Endpoint: cluster.delete_voting_config_exclusions /** - * Clear cluster voting config exclusions. Remove master-eligible nodes from the - * voting configuration exclusion list. + * Clear cluster voting config exclusions. + *

    + * Remove master-eligible nodes from the voting configuration exclusion list. * * @see Documentation @@ -200,8 +209,9 @@ public BooleanResponse deleteVotingConfigExclusions(DeleteVotingConfigExclusions } /** - * Clear cluster voting config exclusions. Remove master-eligible nodes from the - * voting configuration exclusion list. + * Clear cluster voting config exclusions. + *

    + * Remove master-eligible nodes from the voting configuration exclusion list. * * @param fn * a function that initializes a builder to create the @@ -218,8 +228,9 @@ public final BooleanResponse deleteVotingConfigExclusions( } /** - * Clear cluster voting config exclusions. Remove master-eligible nodes from the - * voting configuration exclusion list. + * Clear cluster voting config exclusions. + *

    + * Remove master-eligible nodes from the voting configuration exclusion list. * * @see Documentation @@ -234,8 +245,9 @@ public BooleanResponse deleteVotingConfigExclusions() throws IOException, Elasti // ----- Endpoint: cluster.exists_component_template /** - * Check component templates. Returns information about whether a particular - * component template exists. + * Check component templates. + *

    + * Returns information about whether a particular component template exists. * * @see Documentation @@ -251,8 +263,9 @@ public BooleanResponse existsComponentTemplate(ExistsComponentTemplateRequest re } /** - * Check component templates. Returns information about whether a particular - * component template exists. + * Check component templates. + *

    + * Returns information about whether a particular component template exists. * * @param fn * a function that initializes a builder to create the @@ -271,7 +284,9 @@ public final BooleanResponse existsComponentTemplate( // ----- Endpoint: cluster.get_component_template /** - * Get component templates. Get information about component templates. + * Get component templates. + *

    + * Get information about component templates. * * @see Documentation @@ -287,7 +302,9 @@ public GetComponentTemplateResponse getComponentTemplate(GetComponentTemplateReq } /** - * Get component templates. Get information about component templates. + * Get component templates. + *

    + * Get information about component templates. * * @param fn * a function that initializes a builder to create the @@ -304,7 +321,9 @@ public final GetComponentTemplateResponse getComponentTemplate( } /** - * Get component templates. Get information about component templates. + * Get component templates. + *

    + * Get information about component templates. * * @see Documentation @@ -461,7 +480,9 @@ public HealthResponse health() throws IOException, ElasticsearchException { // ----- Endpoint: cluster.info /** - * Get cluster info. Returns basic information about the cluster. + * Get cluster info. + *

    + * Returns basic information about the cluster. * * @see Documentation @@ -476,7 +497,9 @@ public ClusterInfoResponse info(ClusterInfoRequest request) throws IOException, } /** - * Get cluster info. Returns basic information about the cluster. + * Get cluster info. + *

    + * Returns basic information about the cluster. * * @param fn * a function that initializes a builder to create the @@ -494,9 +517,10 @@ public final ClusterInfoResponse info(Function + * Get information about cluster-level changes (such as create index, update + * mapping, allocate or fail shard) that have not yet taken effect. *

    * NOTE: This API returns a list of any pending updates to the cluster state. * These are distinct from the tasks reported by the task management API which @@ -518,9 +542,10 @@ public PendingTasksResponse pendingTasks(PendingTasksRequest request) throws IOE } /** - * Get the pending cluster tasks. Get information about cluster-level changes - * (such as create index, update mapping, allocate or fail shard) that have not - * yet taken effect. + * Get the pending cluster tasks. + *

    + * Get information about cluster-level changes (such as create index, update + * mapping, allocate or fail shard) that have not yet taken effect. *

    * NOTE: This API returns a list of any pending updates to the cluster state. * These are distinct from the tasks reported by the task management API which @@ -544,9 +569,10 @@ public final PendingTasksResponse pendingTasks( } /** - * Get the pending cluster tasks. Get information about cluster-level changes - * (such as create index, update mapping, allocate or fail shard) that have not - * yet taken effect. + * Get the pending cluster tasks. + *

    + * Get information about cluster-level changes (such as create index, update + * mapping, allocate or fail shard) that have not yet taken effect. *

    * NOTE: This API returns a list of any pending updates to the cluster state. * These are distinct from the tasks reported by the task management API which @@ -568,16 +594,17 @@ public PendingTasksResponse pendingTasks() throws IOException, ElasticsearchExce // ----- Endpoint: cluster.post_voting_config_exclusions /** - * Update voting configuration exclusions. Update the cluster voting config - * exclusions by node IDs or node names. By default, if there are more than - * three master-eligible nodes in the cluster and you remove fewer than half of - * the master-eligible nodes in the cluster at once, the voting configuration - * automatically shrinks. If you want to shrink the voting configuration to - * contain fewer than three nodes or to remove half or more of the - * master-eligible nodes in the cluster at once, use this API to remove - * departing nodes from the voting configuration manually. The API adds an entry - * for each specified node to the cluster’s voting configuration exclusions - * list. It then waits until the cluster has reconfigured its voting + * Update voting configuration exclusions. + *

    + * Update the cluster voting config exclusions by node IDs or node names. By + * default, if there are more than three master-eligible nodes in the cluster + * and you remove fewer than half of the master-eligible nodes in the cluster at + * once, the voting configuration automatically shrinks. If you want to shrink + * the voting configuration to contain fewer than three nodes or to remove half + * or more of the master-eligible nodes in the cluster at once, use this API to + * remove departing nodes from the voting configuration manually. The API adds + * an entry for each specified node to the cluster’s voting configuration + * exclusions list. It then waits until the cluster has reconfigured its voting * configuration to exclude the specified nodes. *

    * Clusters should have no voting configuration exclusions in normal operation. @@ -619,16 +646,17 @@ public BooleanResponse postVotingConfigExclusions(PostVotingConfigExclusionsRequ } /** - * Update voting configuration exclusions. Update the cluster voting config - * exclusions by node IDs or node names. By default, if there are more than - * three master-eligible nodes in the cluster and you remove fewer than half of - * the master-eligible nodes in the cluster at once, the voting configuration - * automatically shrinks. If you want to shrink the voting configuration to - * contain fewer than three nodes or to remove half or more of the - * master-eligible nodes in the cluster at once, use this API to remove - * departing nodes from the voting configuration manually. The API adds an entry - * for each specified node to the cluster’s voting configuration exclusions - * list. It then waits until the cluster has reconfigured its voting + * Update voting configuration exclusions. + *

    + * Update the cluster voting config exclusions by node IDs or node names. By + * default, if there are more than three master-eligible nodes in the cluster + * and you remove fewer than half of the master-eligible nodes in the cluster at + * once, the voting configuration automatically shrinks. If you want to shrink + * the voting configuration to contain fewer than three nodes or to remove half + * or more of the master-eligible nodes in the cluster at once, use this API to + * remove departing nodes from the voting configuration manually. The API adds + * an entry for each specified node to the cluster’s voting configuration + * exclusions list. It then waits until the cluster has reconfigured its voting * configuration to exclude the specified nodes. *

    * Clusters should have no voting configuration exclusions in normal operation. @@ -671,16 +699,17 @@ public final BooleanResponse postVotingConfigExclusions( } /** - * Update voting configuration exclusions. Update the cluster voting config - * exclusions by node IDs or node names. By default, if there are more than - * three master-eligible nodes in the cluster and you remove fewer than half of - * the master-eligible nodes in the cluster at once, the voting configuration - * automatically shrinks. If you want to shrink the voting configuration to - * contain fewer than three nodes or to remove half or more of the - * master-eligible nodes in the cluster at once, use this API to remove - * departing nodes from the voting configuration manually. The API adds an entry - * for each specified node to the cluster’s voting configuration exclusions - * list. It then waits until the cluster has reconfigured its voting + * Update voting configuration exclusions. + *

    + * Update the cluster voting config exclusions by node IDs or node names. By + * default, if there are more than three master-eligible nodes in the cluster + * and you remove fewer than half of the master-eligible nodes in the cluster at + * once, the voting configuration automatically shrinks. If you want to shrink + * the voting configuration to contain fewer than three nodes or to remove half + * or more of the master-eligible nodes in the cluster at once, use this API to + * remove departing nodes from the voting configuration manually. The API adds + * an entry for each specified node to the cluster’s voting configuration + * exclusions list. It then waits until the cluster has reconfigured its voting * configuration to exclude the specified nodes. *

    * Clusters should have no voting configuration exclusions in normal operation. @@ -721,9 +750,10 @@ public BooleanResponse postVotingConfigExclusions() throws IOException, Elastics // ----- Endpoint: cluster.put_component_template /** - * Create or update a component template. Component templates are building - * blocks for constructing index templates that specify index mappings, - * settings, and aliases. + * Create or update a component template. + *

    + * Component templates are building blocks for constructing index templates that + * specify index mappings, settings, and aliases. *

    * An index template can be composed of multiple component templates. To use a * component template, specify it in an index template’s @@ -763,9 +793,10 @@ public PutComponentTemplateResponse putComponentTemplate(PutComponentTemplateReq } /** - * Create or update a component template. Component templates are building - * blocks for constructing index templates that specify index mappings, - * settings, and aliases. + * Create or update a component template. + *

    + * Component templates are building blocks for constructing index templates that + * specify index mappings, settings, and aliases. *

    * An index template can be composed of multiple component templates. To use a * component template, specify it in an index template’s @@ -970,10 +1001,12 @@ public RemoteInfoResponse remoteInfo() throws IOException, ElasticsearchExceptio // ----- Endpoint: cluster.reroute /** - * Reroute the cluster. Manually change the allocation of individual shards in - * the cluster. For example, a shard can be moved from one node to another - * explicitly, an allocation can be canceled, and an unassigned shard can be - * explicitly allocated to a specific node. + * Reroute the cluster. + *

    + * Manually change the allocation of individual shards in the cluster. For + * example, a shard can be moved from one node to another explicitly, an + * allocation can be canceled, and an unassigned shard can be explicitly + * allocated to a specific node. *

    * It is important to note that after processing any reroute commands * Elasticsearch will perform rebalancing as normal (respecting the values of @@ -1011,10 +1044,12 @@ public RerouteResponse reroute(RerouteRequest request) throws IOException, Elast } /** - * Reroute the cluster. Manually change the allocation of individual shards in - * the cluster. For example, a shard can be moved from one node to another - * explicitly, an allocation can be canceled, and an unassigned shard can be - * explicitly allocated to a specific node. + * Reroute the cluster. + *

    + * Manually change the allocation of individual shards in the cluster. For + * example, a shard can be moved from one node to another explicitly, an + * allocation can be canceled, and an unassigned shard can be explicitly + * allocated to a specific node. *

    * It is important to note that after processing any reroute commands * Elasticsearch will perform rebalancing as normal (respecting the values of @@ -1053,10 +1088,12 @@ public final RerouteResponse reroute(Function + * Manually change the allocation of individual shards in the cluster. For + * example, a shard can be moved from one node to another explicitly, an + * allocation can be canceled, and an unassigned shard can be explicitly + * allocated to a specific node. *

    * It is important to note that after processing any reroute commands * Elasticsearch will perform rebalancing as normal (respecting the values of @@ -1094,8 +1131,9 @@ public RerouteResponse reroute() throws IOException, ElasticsearchException { // ----- Endpoint: cluster.state /** - * Get the cluster state. Get comprehensive information about the state of the - * cluster. + * Get the cluster state. + *

    + * Get comprehensive information about the state of the cluster. *

    * The cluster state is an internal data structure which keeps track of a * variety of information needed by every node, including the identity and @@ -1138,8 +1176,9 @@ public StateResponse state(StateRequest request) throws IOException, Elasticsear } /** - * Get the cluster state. Get comprehensive information about the state of the - * cluster. + * Get the cluster state. + *

    + * Get comprehensive information about the state of the cluster. *

    * The cluster state is an internal data structure which keeps track of a * variety of information needed by every node, including the identity and @@ -1183,8 +1222,9 @@ public final StateResponse state(Function + * Get comprehensive information about the state of the cluster. *

    * The cluster state is an internal data structure which keeps track of a * variety of information needed by every node, including the identity and @@ -1227,9 +1267,11 @@ public StateResponse state() throws IOException, ElasticsearchException { // ----- Endpoint: cluster.stats /** - * Get cluster statistics. Get basic index metrics (shard numbers, store size, - * memory usage) and information about the current nodes that form the cluster - * (number, roles, os, jvm versions, memory usage, cpu and installed plugins). + * Get cluster statistics. + *

    + * Get basic index metrics (shard numbers, store size, memory usage) and + * information about the current nodes that form the cluster (number, roles, os, + * jvm versions, memory usage, cpu and installed plugins). * * @see Documentation @@ -1244,9 +1286,11 @@ public ClusterStatsResponse stats(ClusterStatsRequest request) throws IOExceptio } /** - * Get cluster statistics. Get basic index metrics (shard numbers, store size, - * memory usage) and information about the current nodes that form the cluster - * (number, roles, os, jvm versions, memory usage, cpu and installed plugins). + * Get cluster statistics. + *

    + * Get basic index metrics (shard numbers, store size, memory usage) and + * information about the current nodes that form the cluster (number, roles, os, + * jvm versions, memory usage, cpu and installed plugins). * * @param fn * a function that initializes a builder to create the @@ -1263,9 +1307,11 @@ public final ClusterStatsResponse stats( } /** - * Get cluster statistics. Get basic index metrics (shard numbers, store size, - * memory usage) and information about the current nodes that form the cluster - * (number, roles, os, jvm versions, memory usage, cpu and installed plugins). + * Get cluster statistics. + *

    + * Get basic index metrics (shard numbers, store size, memory usage) and + * information about the current nodes that form the cluster (number, roles, os, + * jvm versions, memory usage, cpu and installed plugins). * * @see Documentation diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ExistsComponentTemplateRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ExistsComponentTemplateRequest.java index 59e35effaf..af7b715d15 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ExistsComponentTemplateRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ExistsComponentTemplateRequest.java @@ -61,8 +61,9 @@ // typedef: cluster.exists_component_template.Request /** - * Check component templates. Returns information about whether a particular - * component template exists. + * Check component templates. + *

    + * Returns information about whether a particular component template exists. * * @see API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/GetComponentTemplateRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/GetComponentTemplateRequest.java index e0674420e2..4c0d2eea24 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/GetComponentTemplateRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/GetComponentTemplateRequest.java @@ -59,7 +59,9 @@ // typedef: cluster.get_component_template.Request /** - * Get component templates. Get information about component templates. + * Get component templates. + *

    + * Get information about component templates. * * @see API diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/PendingTasksRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/PendingTasksRequest.java index dd3d455519..255d342d23 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/PendingTasksRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/PendingTasksRequest.java @@ -56,9 +56,10 @@ // typedef: cluster.pending_tasks.Request /** - * Get the pending cluster tasks. Get information about cluster-level changes - * (such as create index, update mapping, allocate or fail shard) that have not - * yet taken effect. + * Get the pending cluster tasks. + *

    + * Get information about cluster-level changes (such as create index, update + * mapping, allocate or fail shard) that have not yet taken effect. *

    * NOTE: This API returns a list of any pending updates to the cluster state. * These are distinct from the tasks reported by the task management API which diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/PostVotingConfigExclusionsRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/PostVotingConfigExclusionsRequest.java index 66b3cd8558..48a5101956 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/PostVotingConfigExclusionsRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/PostVotingConfigExclusionsRequest.java @@ -61,16 +61,17 @@ // typedef: cluster.post_voting_config_exclusions.Request /** - * Update voting configuration exclusions. Update the cluster voting config - * exclusions by node IDs or node names. By default, if there are more than - * three master-eligible nodes in the cluster and you remove fewer than half of - * the master-eligible nodes in the cluster at once, the voting configuration - * automatically shrinks. If you want to shrink the voting configuration to - * contain fewer than three nodes or to remove half or more of the - * master-eligible nodes in the cluster at once, use this API to remove - * departing nodes from the voting configuration manually. The API adds an entry - * for each specified node to the cluster’s voting configuration exclusions - * list. It then waits until the cluster has reconfigured its voting + * Update voting configuration exclusions. + *

    + * Update the cluster voting config exclusions by node IDs or node names. By + * default, if there are more than three master-eligible nodes in the cluster + * and you remove fewer than half of the master-eligible nodes in the cluster at + * once, the voting configuration automatically shrinks. If you want to shrink + * the voting configuration to contain fewer than three nodes or to remove half + * or more of the master-eligible nodes in the cluster at once, use this API to + * remove departing nodes from the voting configuration manually. The API adds + * an entry for each specified node to the cluster’s voting configuration + * exclusions list. It then waits until the cluster has reconfigured its voting * configuration to exclude the specified nodes. *

    * Clusters should have no voting configuration exclusions in normal operation. diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/PutComponentTemplateRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/PutComponentTemplateRequest.java index 049abd41af..903138e2b3 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/PutComponentTemplateRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/PutComponentTemplateRequest.java @@ -62,9 +62,10 @@ // typedef: cluster.put_component_template.Request /** - * Create or update a component template. Component templates are building - * blocks for constructing index templates that specify index mappings, - * settings, and aliases. + * Create or update a component template. + *

    + * Component templates are building blocks for constructing index templates that + * specify index mappings, settings, and aliases. *

    * An index template can be composed of multiple component templates. To use a * component template, specify it in an index template’s diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/RerouteRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/RerouteRequest.java index 1f63486bff..60af316c03 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/RerouteRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/RerouteRequest.java @@ -63,10 +63,12 @@ // typedef: cluster.reroute.Request /** - * Reroute the cluster. Manually change the allocation of individual shards in - * the cluster. For example, a shard can be moved from one node to another - * explicitly, an allocation can be canceled, and an unassigned shard can be - * explicitly allocated to a specific node. + * Reroute the cluster. + *

    + * Manually change the allocation of individual shards in the cluster. For + * example, a shard can be moved from one node to another explicitly, an + * allocation can be canceled, and an unassigned shard can be explicitly + * allocated to a specific node. *

    * It is important to note that after processing any reroute commands * Elasticsearch will perform rebalancing as normal (respecting the values of diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/StateRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/StateRequest.java index 1398dcd978..76dded42f6 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/StateRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/StateRequest.java @@ -61,8 +61,9 @@ // typedef: cluster.state.Request /** - * Get the cluster state. Get comprehensive information about the state of the - * cluster. + * Get the cluster state. + *

    + * Get comprehensive information about the state of the cluster. *

    * The cluster state is an internal data structure which keeps track of a * variety of information needed by every node, including the identity and diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/ElasticsearchConnectorAsyncClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/ElasticsearchConnectorAsyncClient.java index df00ac3f6b..1a39655ed1 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/ElasticsearchConnectorAsyncClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/connector/ElasticsearchConnectorAsyncClient.java @@ -391,9 +391,10 @@ public final CompletableFuture syncJobCancel( // ----- Endpoint: connector.sync_job_check_in /** - * Check in a connector sync job. Check in a connector sync job and set the - * last_seen field to the current time before updating it in the - * internal index. + * Check in a connector sync job. + *

    + * Check in a connector sync job and set the last_seen field to the + * current time before updating it in the internal index. *

    * To sync data using self-managed connectors, you need to deploy the Elastic * connector service on your own infrastructure. This service runs automatically @@ -412,9 +413,10 @@ public CompletableFuture syncJobCheckIn(SyncJobCheckInRe } /** - * Check in a connector sync job. Check in a connector sync job and set the - * last_seen field to the current time before updating it in the - * internal index. + * Check in a connector sync job. + *

    + * Check in a connector sync job and set the last_seen field to the + * current time before updating it in the internal index. *

    * To sync data using self-managed connectors, you need to deploy the Elastic * connector service on your own infrastructure. This service runs automatically @@ -436,10 +438,12 @@ public final CompletableFuture syncJobCheckIn( // ----- Endpoint: connector.sync_job_claim /** - * Claim a connector sync job. This action updates the job status to - * in_progress and sets the last_seen and - * started_at timestamps to the current time. Additionally, it can - * set the sync_cursor property for the sync job. + * Claim a connector sync job. + *

    + * This action updates the job status to in_progress and sets the + * last_seen and started_at timestamps to the current + * time. Additionally, it can set the sync_cursor property for the + * sync job. *

    * This API is not intended for direct connector management by users. It * supports the implementation of services that utilize the connector protocol @@ -462,10 +466,12 @@ public CompletableFuture syncJobClaim(SyncJobClaimRequest } /** - * Claim a connector sync job. This action updates the job status to - * in_progress and sets the last_seen and - * started_at timestamps to the current time. Additionally, it can - * set the sync_cursor property for the sync job. + * Claim a connector sync job. + *

    + * This action updates the job status to in_progress and sets the + * last_seen and started_at timestamps to the current + * time. Additionally, it can set the sync_cursor property for the + * sync job. *

    * This API is not intended for direct connector management by users. It * supports the implementation of services that utilize the connector protocol @@ -530,8 +536,10 @@ public final CompletableFuture syncJobDelete( // ----- Endpoint: connector.sync_job_error /** - * Set a connector sync job error. Set the error field for a - * connector sync job and set its status to error. + * Set a connector sync job error. + *

    + * Set the error field for a connector sync job and set its + * status to error. *

    * To sync data using self-managed connectors, you need to deploy the Elastic * connector service on your own infrastructure. This service runs automatically @@ -550,8 +558,10 @@ public CompletableFuture syncJobError(SyncJobErrorRequest } /** - * Set a connector sync job error. Set the error field for a - * connector sync job and set its status to error. + * Set a connector sync job error. + *

    + * Set the error field for a connector sync job and set its + * status to error. *

    * To sync data using self-managed connectors, you need to deploy the Elastic * connector service on your own infrastructure. This service runs automatically @@ -700,11 +710,13 @@ public final CompletableFuture syncJobPost( // ----- Endpoint: connector.sync_job_update_stats /** - * Set the connector sync job stats. Stats include: - * deleted_document_count, indexed_document_count, - * indexed_document_volume, and total_document_count. - * You can also update last_seen. This API is mainly used by the - * connector service for updating sync job information. + * Set the connector sync job stats. + *

    + * Stats include: deleted_document_count, + * indexed_document_count, indexed_document_volume, + * and total_document_count. You can also update + * last_seen. This API is mainly used by the connector service for + * updating sync job information. *

    * To sync data using self-managed connectors, you need to deploy the Elastic * connector service on your own infrastructure. This service runs automatically @@ -723,11 +735,13 @@ public CompletableFuture syncJobUpdateStats(SyncJobU } /** - * Set the connector sync job stats. Stats include: - * deleted_document_count, indexed_document_count, - * indexed_document_volume, and total_document_count. - * You can also update last_seen. This API is mainly used by the - * connector service for updating sync job information. + * Set the connector sync job stats. + *

    + * Stats include: deleted_document_count, + * indexed_document_count, indexed_document_volume, + * and total_document_count. You can also update + * last_seen. This API is mainly used by the connector service for + * updating sync job information. *

    * To sync data using self-managed connectors, you need to deploy the Elastic * connector service on your own infrastructure. This service runs automatically @@ -910,9 +924,10 @@ public final CompletableFuture updateError( // ----- Endpoint: connector.update_features /** - * Update the connector features. Update the connector features in the connector - * document. This API can be used to control the following aspects of a - * connector: + * Update the connector features. + *

    + * Update the connector features in the connector document. This API can be used + * to control the following aspects of a connector: *